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.

• Client
• Database
• Table
• Savepoint

Concepts

For a good mental model, the Client, Database, and Table APIs are related in the following hierarchy:

• Client:
  • .database() ➞ Database:
    • .table() ➞ Table:
      • .select(), .insert(), .upsert(), .update(), .delete()

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)