@pgpm/jobs 0.5.0 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/Makefile CHANGED
@@ -1,5 +1,5 @@
1
1
  EXTENSION = launchql-jobs
2
- DATA = sql/launchql-jobs--0.4.0.sql
2
+ DATA = sql/launchql-jobs--0.6.0.sql
3
3
 
4
4
  PG_CONFIG = pg_config
5
5
  PGXS := $(shell $(PG_CONFIG) --pgxs)
package/README.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @pgpm/jobs
2
2
 
3
+ <p align="center" width="100%">
4
+ <img height="250" src="https://raw.githubusercontent.com/launchql/launchql/refs/heads/main/assets/outline-logo.svg" />
5
+ </p>
6
+
7
+ <p align="center" width="100%">
8
+ <a href="https://github.com/launchql/pgpm-modules/actions/workflows/ci.yml">
9
+ <img height="20" src="https://github.com/launchql/pgpm-modules/actions/workflows/ci.yml/badge.svg" />
10
+ </a>
11
+ <a href="https://github.com/launchql/pgpm-modules/blob/main/LICENSE"><img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"/></a>
12
+ <a href="https://www.npmjs.com/package/@pgpm/jobs"><img height="20" src="https://img.shields.io/github/package-json/v/launchql/pgpm-modules?filename=packages%2Fjobs%2Fjobs%2Fpackage.json"/></a>
13
+ </p>
14
+
3
15
  Core job system for background task processing in PostgreSQL.
4
16
 
5
17
  ## Overview
@@ -31,40 +43,42 @@ This is a quick way to get started. The sections below provide more detailed ins
31
43
  ### Prerequisites
32
44
 
33
45
  ```bash
34
- # Install pgpm globally
46
+ # Install pgpm CLI
35
47
  npm install -g pgpm
36
48
 
37
- # Start PostgreSQL
49
+ # Start local Postgres (via Docker) and export env vars
38
50
  pgpm docker start
39
-
40
- # Set environment variables
41
51
  eval "$(pgpm env)"
42
52
  ```
43
53
 
44
- ### Deploy
54
+ > **Tip:** Already running Postgres? Skip the Docker step and just export your `PG*` environment variables.
45
55
 
46
- #### Option 1: Deploy by installing with pgpm
56
+ ### **Add to an Existing Package**
47
57
 
48
58
  ```bash
59
+ # 1. Install the package
49
60
  pgpm install @pgpm/jobs
50
- pgpm deploy
61
+
62
+ # 2. Deploy locally
63
+ pgpm deploy
51
64
  ```
52
65
 
53
- #### Option 2: Deploy from Package Directory
66
+ ### **Add to a New Project**
54
67
 
55
68
  ```bash
56
- cd packages/jobs/jobs
57
- pgpm deploy --createdb
58
- ```
69
+ # 1. Create a workspace
70
+ pgpm init --workspace
71
+ cd my-app
59
72
 
60
- #### Option 3: Deploy from Workspace Root
73
+ # 2. Create your first module
74
+ pgpm init
75
+ cd packages/your-module
61
76
 
62
- ```bash
63
- # Install workspace dependencies
64
- pgpm install
77
+ # 3. Install a package
78
+ pgpm install @pgpm/jobs
65
79
 
66
- # Deploy with dependencies
67
- pgpm deploy mydb1 --yes --createdb
80
+ # 4. Deploy everything
81
+ pgpm deploy --createdb --database mydb1
68
82
  ```
69
83
 
70
84
  ## Core Schema
@@ -285,76 +299,6 @@ Executes a scheduled job.
285
299
  pnpm test
286
300
  ```
287
301
 
288
- ## Development
289
-
290
- See the [Development](#development) section below for information on working with this package.
291
-
292
- ---
293
-
294
- ## Development
295
-
296
- ### **Before You Begin**
297
-
298
- ```bash
299
- # 1. Install pgpm
300
- npm install -g pgpm
301
-
302
- # 2. Start Postgres (Docker or local)
303
- pgpm docker start
304
-
305
- # 3. Load PG* environment variables (PGHOST, PGUSER, ...)
306
- eval "$(pgpm env)"
307
- ```
308
-
309
- ---
310
-
311
- ### **Starting a New Project**
312
-
313
- ```bash
314
- # 1. Create a workspace
315
- pgpm init --workspace
316
- cd my-app
317
-
318
- # 2. Create your first module
319
- pgpm init
320
-
321
- # 3. Add a migration
322
- pgpm add some_change
323
-
324
- # 4. Deploy (auto-creates database)
325
- pgpm deploy --createdb
326
- ```
327
-
328
- ---
329
-
330
- ### **Working With an Existing Project**
331
-
332
- ```bash
333
- # 1. Clone and enter the project
334
- git clone <repo> && cd <project>
335
-
336
- # 2. Install dependencies
337
- pnpm install
338
-
339
- # 3. Deploy locally
340
- pgpm deploy --createdb
341
- ```
342
-
343
- ---
344
-
345
- ### **Testing a Module Inside a Workspace**
346
-
347
- ```bash
348
- # 1. Install workspace deps
349
- pnpm install
350
-
351
- # 2. Enter the module directory
352
- cd packages/<some-module>
353
-
354
- # 3. Run tests in watch mode
355
- pnpm test:watch
356
- ```
357
-
358
302
  ## Related Tooling
359
303
 
360
304
  * [pgpm](https://github.com/launchql/launchql/tree/main/packages/pgpm): **🖥️ PostgreSQL Package Manager** for modular Postgres development. Works with database workspaces, scaffolding, migrations, seeding, and installing database packages.
@@ -1,6 +1,6 @@
1
1
  # launchql-jobs extension
2
2
  comment = 'launchql-jobs extension'
3
- default_version = '0.4.0'
3
+ default_version = '0.6.0'
4
4
  module_pathname = '$libdir/launchql-jobs'
5
5
  requires = 'plpgsql,uuid-ossp,pgcrypto,launchql-default-roles,launchql-verify'
6
6
  relocatable = false
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pgpm/jobs",
3
- "version": "0.5.0",
3
+ "version": "0.7.0",
4
4
  "description": "Core job system for background task processing in PostgreSQL",
5
5
  "publishConfig": {
6
6
  "access": "public"
@@ -11,19 +11,19 @@
11
11
  "test:watch": "jest --watch"
12
12
  },
13
13
  "dependencies": {
14
- "@pgpm/default-roles": "0.5.0",
15
- "@pgpm/verify": "0.5.0"
14
+ "@pgpm/default-roles": "0.7.0",
15
+ "@pgpm/verify": "0.7.0"
16
16
  },
17
17
  "devDependencies": {
18
18
  "pgpm": "^0.2.0"
19
19
  },
20
20
  "repository": {
21
21
  "type": "git",
22
- "url": "https://github.com/launchql/extensions"
22
+ "url": "https://github.com/launchql/pgpm-modules"
23
23
  },
24
- "homepage": "https://github.com/launchql/extensions",
24
+ "homepage": "https://github.com/launchql/pgpm-modules",
25
25
  "bugs": {
26
- "url": "https://github.com/launchql/extensions/issues"
26
+ "url": "https://github.com/launchql/pgpm-modules/issues"
27
27
  },
28
- "gitHead": "d8eedbb24ad22a106634bc3b919bfb8d41976c16"
28
+ "gitHead": "1f24d8fa95fb141f16e5b8345458c3b687d80908"
29
29
  }