db9-ai/DB9 Action
Create temporary DB9 databases for GitHub Actions.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| mode | Operation to run. Use database for an empty ephemeral database, branch to clone from an existing database, or cleanup to delete stale CI databases by prefix. | no | database |
| database-name | Name for the DB9 database or branch. Defaults to a generated name based on the workflow run. | no | — |
| database-name-prefix | Prefix used when generating a database name. | no | gha |
| worker-id | Optional worker or matrix identifier appended to generated database names. | no | — |
| region | DB9 region to create the database in. | no | — |
| project-id | DB9 project ID to create the database in. | no | — |
| database-user | Database user to request in the temporary connection URL. | no | admin |
| source-database-id | Source DB9 database ID for branch mode. | no | — |
| source-database-name | Source DB9 database name for branch mode. Used only when source-database-id is not set. | no | — |
| snapshot-at | Optional RFC3339 timestamp for point-in-time branch mode. | no | — |
| wait | Wait for the created database or branch to become ACTIVE before fetching the connection URL. | no | true |
| wait-timeout-seconds | Maximum seconds to wait for a database or branch to become ACTIVE. | no | 120 |
| wait-interval-seconds | Seconds between database status polls while waiting. | no | 2 |
| cleanup-prefix | Database name prefix to delete in cleanup mode. | no | — |
| db9-api-key | DB9 API key. Omit this input to use anonymous DB9 provisioning. | no | — |
| db9-api-url | DB9 API base URL. | no | — |
| cleanup | Delete the created database in the action post step. | no | true |
| export-env | Export DATABASE_URL, DB9_DATABASE_URL, and DB9_DATABASE for later steps. | no | true |
Outputs
| name | description |
|---|---|
| database-url | Temporary PostgreSQL connection URL for the created DB9 database or branch. |
| database-name | Name of the created DB9 database or branch. |
| database-id | ID of the created DB9 database or branch, when returned by the DB9 API. |
| database-user | Database user used for the temporary connection URL. |
| expires-at | Expiration timestamp for the temporary connection URL, when returned by the DB9 API. |
| database-state | Final state observed for the created DB9 database or branch. |
| cleanup-count | Number of databases deleted in cleanup mode. |