API

This is a progressive documentation of the Linked QL API.

High Level APIs

These are the high-level database abstraction APIs in Linked QL.

API	Description
Client	The top-level Linked QL API
Database	The database-level Linked QL API
Table	The table-level Linked QL API
Savepoint	The Savepoint API

The Client, Database, and Table APIs have the following relationship:

Client
    .database(): Database
        .table(): Table

These APIs at play could look something like:

// Create database "database_1"
await client.createDatabase(
    'database_1',
    { ifNotExists: true }
);

// Enter "database_1" and create a table
await client.database('database_1').createTable({
    name: 'table_1', columns: [
        { name: 'column_1', type: 'int', identity: true, primaryKey: true },
        { name: 'column_2', type: 'varchar' },
        { name: 'column_3', type: 'varchar' },
    ]
});

// Enter "table_1" and insert data
await client.database('database_1').table('table_1').insert({
    column_2: 'Column 2 test content',
    column_3: 'Column 3 test content',
});

While the primary query API in here is client.query(), Linked QL comes with the additional APIs to let you programmatically do the same things possible with client.query().

DQL APIs

(Docs coming soon)

DML APIs

(Docs coming soon)

DDL APIs

(Docs coming soon)