surrealised/dist/index.d.ts

Another SurrealDB Library for NodeJS

import { Surreal } from 'surrealdb.js';
import { LiveQueryResponse } from 'surrealdb.js/script/types';

type OrderByField = Record<string, "ASC" | "DESC">;
declare class SurrealQueryBuilder$1 {
    private table;
    private fields;
    private omitFields;
    private whereClauses;
    private currentClauseGroup;
    private group_all;
    private orderByFields;
    private isInWhereClause;
    private grouping;
    private fetchItems;
    private splitItems;
    private groupByItems;
    private withIndex;
    private offsetClause?;
    private limitClause?;
    variables: Record<string, any>;
    constructor(table: string);
    /**
     * Select fields to return
     * https://docs.surrealdb.com/docs/surrealql/statements/select#basic-usage
     * @param fields
     */
    select(...fields: string[]): this;
    /**
     * Start a condition, MUST be present before any AND or OR statements
     * https://docs.surrealdb.com/docs/surrealql/statements/select#filter-queries-using-the-where-clause
     * @param condition
     */
    where(condition: string): this;
    /**
     * Add conditions to the query
     * https://docs.surrealdb.com/docs/surrealql/statements/select#connect-targets-using-the-fetch-clause
     * @param condition
     */
    and(condition: string): this;
    /**
     * Or what?
     * https://docs.surrealdb.com/docs/surrealql/statements/select#connect-targets-using-the-fetch-clause
     * @param condition
     */
    or(condition: string): this;
    endGroup(): this;
    /**
     * Specify record joins to fetch the details of
     * https://docs.surrealdb.com/docs/surrealql/statements/select#connect-targets-using-the-fetch-clause
     * @param fields
     */
    fetch(...fields: string[]): this;
    /**
     * Offset the results by a number
     * https://docs.surrealdb.com/docs/surrealql/statements/select#the-limit-clause
     * @param n
     */
    offset(n: number): this;
    /**
     * Limit the number of results
     * https://docs.surrealdb.com/docs/surrealql/statements/select#the-limit-clause
     * @param n - the number to limit it to
     */
    limit(n: number): this;
    /**
     * Group the results by a field or set of fields
     * https://docs.surrealdb.com/docs/surrealql/statements/select#the-group-by-and-group-all-clause
     * @param fields
     */
    groupBy(...fields: string[]): this;
    /**
     * Group all results
     * https://docs.surrealdb.com/docs/surrealql/statements/select#the-group-by-and-group-all-clause
     */
    groupAll(): this;
    /**
     * Order the results by a set of fields
     * https://docs.surrealdb.com/docs/surrealql/statements/select#sort-records-using-the-order-by-clause
     * @param fields
     */
    orderBy(...fields: OrderByField[]): this;
    /**
     * Split the query results via a field
     * https://docs.surrealdb.com/docs/surrealql/statements/select#the-split-clause
     * @param fields
     */
    split(...fields: string[]): this;
    /**
     * Add indexes to the query
     * https://docs.surrealdb.com/docs/surrealql/statements/select#the-with-clause
     * @param indexes
     */
    index(...indexes: string[]): this;
    /**
     * Omit fields from the result, these are still used in conditionals (I think?)
     * @param fields
     */
    omit(...fields: string[]): this;
    private assertClauseGroup;
    /**
     * Construct the query string
     */
    build(ignore_pagination?: boolean, ignore_filters?: boolean): string;
    /**
     * Execute the query and return a single row (or none)
     * @param params
     */
    queryOne<T>(params?: Record<string, any>): Promise<T>;
    /**
     * Execute the query and return many rows
     * @param params
     */
    queryMany<T>(params?: Record<string, any>): Promise<T[]>;
    /**
     * Add a variable to the query for execution.
     * @param key
     * @param value
     */
    addVariable(key: string, value: any): this;
    /**
     * Remove a variable from the query
     * @param key
     */
    removeVariable(key: string): this;
    /**
     * Clear all variables from the query
     */
    clearVariables(): this;
    /**
     * Get the total number of rows that would be returned by the query, by default this ignore pagination
     * @param ignoreFilter - ignore WHERE clauses
     */
    total(ignoreFilter?: boolean): Promise<number>;
}

interface SurrealClientOptions {
    debug?: boolean;
    connection?: {
        host?: string;
        user?: string;
        password?: string;
        namespace?: string;
        database?: string;
    };
}
declare class SurrealClient {
    private HOST;
    private USER;
    private PASSWORD;
    private NAMESPACE;
    private DATABASE;
    private isDebug;
    private client;
    private isConnected;
    constructor(options?: SurrealClientOptions);
    init(): Promise<Surreal>;
    private debugMessage;
    connect(): Promise<void>;
    /**
     * Execute a query and return the first row.
     * If there are multiple queries, it will return the first row of the last query.
     * @param query
     * @param params
     */
    queryOne<T = any>(query: string, params?: any): Promise<T>;
    /**
     * Execute a query and return many rows.
     * If there are multiple queries, it will return the results of the last query.
     * @param quest
     * @param params
     */
    queryMany<T = any>(quest: string, params?: any): Promise<T[]>;
    /**
     * Create a key with value
     * @param key
     * @param value
     */
    create<T = any>(key: string, value: any): Promise<T>;
    /**
     * Fetch a key
     * @param key
     */
    fetch<T = any>(key: string): Promise<T>;
    /**
     * Fetch many keys from {table}
     * @param {string} table
     */
    fetchMany<T = any>(table: string): Promise<T[]>;
    /**
     * Update a key, will merge if it exists, otherwise will create
     * @param key
     * @param value
     */
    update<T = any>(key: string, value: any): Promise<T>;
    /**
     * Delete a key
     * @param key
     */
    delete(key: string): Promise<{
        [x: string]: any;
    }>;
    /**
     * Execute a raw query, return the native SurrealDB Library Result
     * @param query
     * @param params
     */
    execute(query: string, params?: any): Promise<void>;
    /**
     * Relate two records together using a join table
     * @param table - The join table name (i.e. "visited")
     * @param from - The key of the record to relate from (i.e. "user:1")
     * @param to - The key of the record to relate to (i.e. "office:sydney")
     * @param value - The value to store in the join table (i.e. "{visitedAt: '2021-01-01', ...}")
     */
    relate(table: string, from: string, to: string, value?: Record<string, any>): Promise<void>;
    begin(): Promise<void>;
    commit(): Promise<unknown[]>;
    close(): Promise<void>;
    live(table: string, callback: (data: LiveQueryResponse<Record<string, any>>) => any): Promise<void>;
}
declare const SurrealQueryBuilder: typeof SurrealQueryBuilder$1;

export { SurrealQueryBuilder, SurrealClient as default };