Namespace

Seagull – 1.0

A SQLite3 utility library

Version0.3.0-dev
AuthorsSeagull Developers
LicenseLGPL-2.1-or-later
Websitehttps://keep.imfreedom.org/seagull/seagull/
Sourcehttps://keep.imfreedom.org/seagull/seagull/

Build

C headersseagull.h
pkg-config filesseagull

Dependencies

GLib—2.0 General-purpose, portable utility library.
Browse documentation
GObject—2.0 The base type system library.
Browse documentation
Gio—2.0 Stream based io library.
Browse documentation

Additional documentation

Classes

Statement

A wrapper around sqlite3_stmt to make it easier to work with named parameters.

unstable since: 0.3

Aliases

Sqlite3

A sqlite3 connection.

Sqlite3Stmt

A sqlite3_stmt alias.

Error Domains

DBError

Error codes returned when creating and closing databases.

since: 0.2

MigrationsError

Error codes returned when running migrations.

since: 0.1

StatementError

Error codes returned by statements.

unstable since: 0.3

TransactionError

Error codes returned by the transaction functions.

since: 0.2

Functions

check_version

Checks that the seagull version is compatible with the requested version.

since: 0.1

db_close

Closes a database instance.

since: 0.2

db_error_quark

The error domain to identify errors when opening and closing databases.

since: 0.2

db_new_from_file

Creates a new database with the given filename.

since: 0.2

db_new_from_uri

Creates a new database from a URI.

since: 0.2

db_new_in_memory

Creates a new in memory database.

since: 0.2

migrations_get_schema_version

Attempts to read the result of PRAGMA user_version which this API uses to store the schema version.

since: 0.1

migrations_run_from_resources

Runs the given migrations in the order they are given. The index of each migration plus 1 is assumed to be the version number of the migration, which means that you can not change the order of the migrations. The reasoning for the addition of 1 is because PRAGMA user_version defaults to 0.

since: 0.1

migrations_run_from_strings

Runs the given migrations in the order they are given. The index of each migration plus 1 is assumed is to be the version number of the migration, which means that you can not change the order of the migrations. The reasoning for the addition of 1 is because PRAGMA user_version defaults to 0.

since: 0.1

transaction_begin

Begins a transaction.

since: 0.2

transaction_commit

Commits a transaction.

since: 0.2

transaction_error_quark

The error domain to identify errors with transactions.

since: 0.2

transaction_rollback

Rolls back a transaction.

since: 0.2

Function Macros

CHECK_VERSION

Checks the version of seagull being compiled against. See seagull_check_version() for a runtime check.

since: 0.1

Constants

EXTRA_VERSION

The extra version of the version of Seagull that was compiled against.

MAJOR_VERSION

The major version of the version of Seagull that was compiled against.

MICRO_VERSION

The micro version of the version of Seagull that was compiled against.

MINOR_VERSION

The minor version of the version of Seagull that was compiled against.

VERSION

The full version number for the version of Seagull that was compiled against.

VERSION_MIN_REQUIRED

A macro that should be defined by the user prior to including the seagull.h header.