@decaf-ts/for-postgres
Version:
template for ts projects
54 lines (53 loc) • 2.5 kB
TypeScript
import { SQLOperator } from "../types";
/**
* @description Default query limit for PostgreSQL queries
* @summary Maximum number of rows to return in a single query
* @const PostgreSQLQueryLimit
* @memberOf module:for-postgres
*/
export declare const PostgreSQLQueryLimit = 250;
/**
* @description Mapping of operator names to PostgreSQL SQL operators
* @summary Constants for PostgreSQL comparison operators used in SQL queries
* @typedef {Object} PostgreSQLOperatorType
* @property {string} EQUAL - Equality operator (=)
* @property {string} DIFFERENT - Inequality operator (<>)
* @property {string} BIGGER - Greater than operator (>)
* @property {string} BIGGER_EQ - Greater than or equal operator (>=)
* @property {string} SMALLER - Less than operator (<)
* @property {string} SMALLER_EQ - Less than or equal operator (<=)
* @property {string} NOT - Negation operator (NOT)
* @property {string} IN - In array operator (IN)
* @property {string} REGEXP - Regular expression operator (~)
* @property {string} IREGEXP - Case-insensitive regular expression operator (~*)
* @property {string} LIKE - Pattern matching operator (LIKE)
* @property {string} ILIKE - Case-insensitive pattern matching operator (ILIKE)
* @property {string} BETWEEN - Range operator (BETWEEN)
* @property {string} IS_NULL - NULL check operator (IS NULL)
* @property {string} IS_NOT_NULL - NOT NULL check operator (IS NOT NULL)
* @const PostgreSQLOperator
* @type {PostgreSQLOperatorType}
* @memberOf module:for-postgres
*/
export declare const PostgreSQLOperator: Record<string, SQLOperator | string>;
/**
* @description Mapping of logical operator names to PostgreSQL SQL operators
* @summary Constants for PostgreSQL logical operators used in SQL queries
* @typedef {Object} PostgreSQLGroupOperatorType
* @property {string} AND - Logical AND operator (AND)
* @property {string} OR - Logical OR operator (OR)
* @const PostgreSQLGroupOperator
* @type {PostgreSQLGroupOperatorType}
* @memberOf module:for-postgres
*/
export declare const PostgreSQLGroupOperator: Record<string, string>;
/**
* @description Special constant values used in PostgreSQL queries
* @summary String constants representing special values in PostgreSQL
* @typedef {Object} PostgreSQLConstType
* @property {string} NULL - String representation of null value
* @const PostgreSQLConst
* @type {PostgreSQLConstType}
* @memberOf module:for-postgres
*/
export declare const PostgreSQLConst: Record<string, string>;