table.select()

Programmatically perform an SELECT query.

Syntax

table.select(
    fields?: Field[],
    modifiers?: QueryOptions | LimitClause | Callback,
): Promise<QueryResult>;

table.select(
    arg?: {
        fields?: Field[];
    } & QueryOptions | LimitClause | Callback
): Promise<QueryResult>;

Param	Description
fields?	Fields list.
modifiers?	Query modifiers.

└ QueryOptions

interface QueryOptions {
    where?: WhereClause;
    limit?: LimitClause;
    orderBy?: OrderByClause;
    groupBy?: GroupByClause;
}

Param	Description
where?	The WHERE clause.
limit?	The LIMIT clause.
orderBy?	The ORDER BY clause.
groupBy?	The GROUP BY clause.

└ QueryResult

type QueryResult = Array<object> | object;

Type	Description
Array<object>	An array of objects by default.
object	A single object.

Usage

Two-parameter call pattern:

/**
 * SELECT first_name, last_name, email
 * LIMIT 4
 */
const result = await table.select(['first_name', 'last_name', 'email'], 4);

Single-parameter call pattern:

/**
 * SELECT first_name, last_name, email
 */
const result = await table.select(['first_name', 'last_name', 'email']);

/**
 * SELECT *
 * LIMIT 4
 */const result = await table.select(4);

/**
 * SELECT first_name, last_name, email
 * LIMIT 4
 */
const result = await table.select({
    fields: ['first_name', 'last_name', 'email'],
    limit: 4
});

Zero-parameter call pattern:

/**
 * SELECT *
 */
const result = await table.select();

Find by ID (with actual ID column name automatically figured by Linked QL):

/**
 * SELECT *
 * WHERE automatically_figured_primary_key_name = 4
 */
const result = await table.select({ where: 1 });
console.log(result); // single result object