ts-prorm-orm 1.1.0 → 1.2.0

package/dist/sql-constants.d.ts

@@ -0,0 +1,240 @@
+/**
+ * SQL Constants for database behavior control
+ * Provides dialect-specific SQL statements for controlling database behavior
+ * like foreign key checks, transaction isolation levels, etc.
+ */
+/**
+ * Transaction isolation levels
+ */
+export interface IsolationLevel {
+    READ_UNCOMMITTED: string;
+    READ_COMMITTED: string;
+    REPEATABLE_READ: string;
+    SERIALIZABLE: string;
+}
+/**
+ * Foreign key check settings
+ */
+export interface ForeignKeyChecks {
+    disable: string;
+    enable: string;
+}
+/**
+ * Unique key check settings
+ */
+export interface UniqueKeyChecks {
+    disable: string;
+    enable: string;
+}
+/**
+ * Autocommit settings
+ */
+export interface Autocommit {
+    on: string;
+    off: string;
+}
+/**
+ * Cache settings
+ */
+export interface Cache {
+    on: string;
+    off: string;
+}
+/**
+ * SQL mode settings
+ */
+export interface SqlMode {
+    STRICT_TRANS_TABLES: string;
+    NO_ZERO_DATE: string;
+    NO_ZERO_IN_DATE: string;
+    ERROR_FOR_DIVISION_BY_ZERO: string;
+    NO_AUTO_CREATE_USER: string;
+    NO_ENGINE_SUBSTITUTION: string;
+    ALL: string;
+    TRADITIONAL: string;
+}
+/**
+ * SQLite PRAGMA settings
+ */
+export interface PragmaSettings {
+    foreign_keys: {
+        on: string;
+        off: string;
+    };
+    trusted_schema: {
+        on: string;
+        off: string;
+    };
+    journal_mode: {
+        WAL: string;
+        DELETE: string;
+        TRUNCATE: string;
+        PERSIST: string;
+        MEMORY: string;
+    };
+    synchronous: {
+        OFF: string;
+        NORMAL: string;
+        FULL: string;
+        EXTRA: string;
+    };
+}
+/**
+ * Constraint deferral settings (PostgreSQL)
+ */
+export interface ConstraintDeferral {
+    DEFERRED: string;
+    IMMEDIATE: string;
+}
+/**
+ * Search path settings (PostgreSQL)
+ */
+export interface SearchPath {
+    set: (schema: string) => string;
+    reset: string;
+}
+/**
+ * MySQL/MariaDB SQL constants
+ */
+export interface MySQLConstants {
+    FOREIGN_KEY_CHECKS: ForeignKeyChecks;
+    UNIQUE_KEY_CHECKS: UniqueKeyChecks;
+    ISOLATION_LEVEL: IsolationLevel;
+    AUTOCOMMIT: Autocommit;
+    CACHE: Cache;
+    SQL_MODE: SqlMode;
+}
+/**
+ * PostgreSQL SQL constants
+ */
+export interface PostgresConstants {
+    ISOLATION_LEVEL: IsolationLevel;
+    CONSTRAINT_DEFERral: ConstraintDeferral;
+    SEARCH_PATH: SearchPath;
+    AUTOCOMMIT: Autocommit;
+    CACHE: Cache;
+}
+/**
+ * SQLite SQL constants
+ */
+export interface SQLiteConstants {
+    PRAGMA: PragmaSettings;
+    ISOLATION_LEVEL: IsolationLevel;
+}
+/**
+ * CockroachDB SQL constants (PostgreSQL wire-compatible)
+ */
+export type CockroachDBConstants = PostgresConstants;
+/**
+ * Amazon Redshift SQL constants (PostgreSQL 8.0 derived)
+ */
+export type RedshiftConstants = PostgresConstants;
+/**
+ * IBM Db2 SQL constants
+ */
+export interface DB2Constants {
+    ISOLATION_LEVEL: IsolationLevel;
+    AUTOCOMMIT: Autocommit;
+    FOREIGN_KEY_CHECKS: ForeignKeyChecks;
+}
+/**
+ * Snowflake SQL constants
+ */
+export interface SnowflakeConstants {
+    ISOLATION_LEVEL: IsolationLevel;
+    AUTOCOMMIT: Autocommit;
+    CACHE: Cache;
+}
+/**
+ * ClickHouse SQL constants
+ */
+export interface ClickHouseConstants {
+    ISOLATION_LEVEL: IsolationLevel;
+    AUTOCOMMIT: Autocommit;
+    CACHE: Cache;
+}
+/**
+ * Combined SQL constants for all dialects
+ */
+export interface SQLConstants {
+    mysql: MySQLConstants;
+    mariadb: MySQLConstants;
+    postgres: PostgresConstants;
+    sqlite: SQLiteConstants;
+    cockroachdb: CockroachDBConstants;
+    redshift: RedshiftConstants;
+    db2: DB2Constants;
+    snowflake: SnowflakeConstants;
+    clickhouse: ClickHouseConstants;
+}
+/**
+ * MySQL/MariaDB SQL constants
+ */
+export declare const MYSQL: MySQLConstants;
+/**
+ * MariaDB SQL constants (extends MySQL with additional options)
+ */
+export declare const MARIADB: MySQLConstants;
+/**
+ * PostgreSQL SQL constants
+ */
+export declare const POSTGRES: PostgresConstants;
+/**
+ * SQLite SQL constants
+ */
+export declare const SQLITE: SQLiteConstants;
+/**
+ * CockroachDB SQL constants
+ * CockroachDB is wire-compatible with PostgreSQL and shares most session-level
+ * SQL syntax, though it internally maps all isolation levels to SERIALIZABLE.
+ */
+export declare const COCKROACHDB: CockroachDBConstants;
+/**
+ * Amazon Redshift SQL constants
+ * Redshift is derived from PostgreSQL 8.0.2 and only supports the
+ * SERIALIZABLE (default) and READ COMMITTED isolation levels.
+ */
+export declare const REDSHIFT: RedshiftConstants;
+/**
+ * IBM Db2 SQL constants
+ * Db2 isolation levels use single-letter codes: UR (uncommitted read),
+ * CS (cursor stability), RS (read stability), RR (repeatable read).
+ */
+export declare const DB2: DB2Constants;
+/**
+ * Snowflake SQL constants
+ * Snowflake session parameters are configured via ALTER SESSION SET.
+ * Snowflake enforces READ COMMITTED semantics for all statements, so the
+ * other isolation levels map to the same session behavior.
+ */
+export declare const SNOWFLAKE: SnowflakeConstants;
+/**
+ * ClickHouse SQL constants
+ * ClickHouse transactions are experimental and scoped via session settings;
+ * isolation level is effectively fixed and controlled through the
+ * `transaction_isolation` setting where supported.
+ */
+export declare const CLICKHOUSE: ClickHouseConstants;
+/**
+ * All SQL constants
+ */
+export declare const SQL: SQLConstants;
+/**
+ * Get SQL constants for a specific dialect
+ * @param dialect - The dialect name ('mysql', 'mariadb', 'postgres', 'sqlite',
+ * 'cockroachdb', 'redshift', 'db2', 'snowflake', 'clickhouse')
+ */
+export declare function getConstantsForDialect(dialect: string): MySQLConstants | PostgresConstants | SQLiteConstants | DB2Constants | SnowflakeConstants | ClickHouseConstants;
+/**
+ * Transaction isolation level enum
+ */
+export declare enum IsolationLevelEnum {
+    READ_UNCOMMITTED = "READ_UNCOMMITTED",
+    READ_COMMITTED = "READ_COMMITTED",
+    REPEATABLE_READ = "REPEATABLE_READ",
+    SERIALIZABLE = "SERIALIZABLE"
+}
+/**
+ * Type for isolation level values
+ */
+export type IsolationLevelValue = keyof typeof IsolationLevelEnum;