Migrations

Migrations are implemented with https://github.com/golang-migrate/migrate

Install the CLI

To add new migrations, install the CLI. The version of the CLI is not particularly important.

go install -tags 'postgres' github.com/golang-migrate/migrate/v4/cmd/[email protected]

Adding migrations

Adding new migrations is done with the migrate create command

migrate create -dir backends/postgres/migrations -ext sql <descriptive_migration_name>

Running migrations

Migrations are run every time neoq initializes the postgres backend. There is no need to run migrations explicitly.

# Functions

Backend

Backend initializes a new postgres-backed neoq backend If the database does not yet exist, Neoq will attempt to create the database and related tables by default.

GetPQConnectionString

No description provided by the author

WithConnectionString

WithConnectionString configures neoq postgres backend to use the specified connection string when connecting to a backend.

WithConnectionTimeout

WithConnectionTimeout sets the duration that Neoq waits for connections to become available to process and enqueue jobs Note: ConnectionTimeout does not affect how long neoq waits for connections to run schema migrations.

WithSynchronousCommit

WithSynchronousCommit enables postgres parameter `synchronous_commit`.

WithTransactionTimeout

WithTransactionTimeout sets the time that PgBackend's transactions may be idle before its underlying connection is closed The timeout is the number of milliseconds that a transaction may sit idle before postgres terminates the transaction's underlying connection.