Class SQLiteAdvanced

SQLite Advanced Features Class Provides comprehensive SQLite-specific features beyond standard SQL

Index

Constructors

Methods

createView dropView listViews getViewDefinition createTrigger createAfterInsertTrigger createAfterUpdateTrigger createAfterDeleteTrigger createBeforeInsertTrigger createBeforeUpdateTrigger createInsteadOfTrigger createRecursiveTrigger dropTrigger listTriggers getTriggerDefinition createFTS5Table createFTS5FromTable dropFTS5Table fullTextSearch rebuildFTS5 optimizeFTS5 parseJson jsonExtract jsonSet jsonArrayAppend jsonRemove jsonArrayLength jsonContains jsonEach jsonTree jsonType jsonValid jsonEachQuery createTableWithGeneratedColumns createVirtualColumn createStoredColumn createUniqueIndex createPartialIndex createExpressionIndex createIndexIfNotExists listIndexes reindex buildWindowFunction rowNumber rank denseRank ntile lag lead firstValue lastValue nthValue buildCTE buildMultipleCTEs executeRecursiveCTE generateSequence vacuum analyze analyzeDetailed getTableStats getIndexStats savepoint releaseSavepoint rollbackToSavepoint withSavepoint buildUpsertQuery upsert jsonEachAsTable jsonTreeAsTable generateSeries fts5Search loadExtension setExtensionLoading getLoadedExtensions createIntegerPrimaryKey createColumnWithAffinity getColumnAffinity createCheckConstraint createTableWithOnConflict addOnConflictClause createUniqueConstraint createNotNullConstraint pragma getDatabaseInfo setDatabaseOptions getTableInfo getIndexList getForeignKeyList escapeId escape

Constructors

constructor

new SQLiteAdvanced(dialect: SQLiteDialect): SQLiteAdvanced
Parameters
- dialect: SQLiteDialect
Returns SQLiteAdvanced
- Defined in sqlite-advanced.ts:62

Methods

createView

createView(
    viewName: string,
    definition: string | ViewDefinition,
    options?: { replace?: boolean; temporary?: boolean; columns?: string[] },
): Promise<void>
Create a standard or updatable view SQLite views are read-only by default, but can be made updatable via INSTEAD OF triggers
Parameters
- viewName: string
- definition: string | ViewDefinition
  The view body as query options (preferred), or a raw SELECT string. See ViewDefinition.
- Optionaloptions: { replace?: boolean; temporary?: boolean; columns?: string[] }
Returns Promise<void>
- Defined in sqlite-advanced.ts:78

dropView

dropView(
viewName: string,
options?: { ifExists?: boolean; cascade?: boolean },
): Promise<void>
Drop a view
Parameters
- viewName: string
- Optionaloptions: { ifExists?: boolean; cascade?: boolean }
Returns Promise<void>
- Defined in sqlite-advanced.ts:108

listViews

listViews(schema?: string): Promise<string[]>
List all views in the database
Parameters
- Optionalschema: string
Returns Promise<string[]>
- Defined in sqlite-advanced.ts:126

getViewDefinition

getViewDefinition(viewName: string): Promise<string | null>
Get view definition
Parameters
- viewName: string
Returns Promise<string | null>
- Defined in sqlite-advanced.ts:137

createTrigger

createTrigger(
    triggerName: string,
    timing: TriggerTiming,
    events: TriggerEvent[],
    tableName: string,
    body: string,
    options?: {
        replace?: boolean;
        forEachRow?: boolean;
        whenCondition?: string;
    },
): Promise<void>
Create a trigger
Parameters
- triggerName: string
- timing: TriggerTiming
- events: TriggerEvent[]
- tableName: string
- body: string
- Optionaloptions: { replace?: boolean; forEachRow?: boolean; whenCondition?: string }
Returns Promise<void>
- Defined in sqlite-advanced.ts:150

createAfterInsertTrigger

createAfterInsertTrigger(
    triggerName: string,
    tableName: string,
    body: string,
): Promise<void>
Create an AFTER INSERT trigger
Parameters
- triggerName: string
- tableName: string
- body: string
Returns Promise<void>
- Defined in sqlite-advanced.ts:188

createAfterUpdateTrigger

createAfterUpdateTrigger(
    triggerName: string,
    tableName: string,
    body: string,
    columns?: string[],
): Promise<void>
Create an AFTER UPDATE trigger
Parameters
- triggerName: string
- tableName: string
- body: string
- Optionalcolumns: string[]
Returns Promise<void>
- Defined in sqlite-advanced.ts:201

createAfterDeleteTrigger

createAfterDeleteTrigger(
    triggerName: string,
    tableName: string,
    body: string,
): Promise<void>
Create an AFTER DELETE trigger
Parameters
- triggerName: string
- tableName: string
- body: string
Returns Promise<void>
- Defined in sqlite-advanced.ts:216

createBeforeInsertTrigger

createBeforeInsertTrigger(
    triggerName: string,
    tableName: string,
    body: string,
): Promise<void>
Create a BEFORE INSERT trigger
Parameters
- triggerName: string
- tableName: string
- body: string
Returns Promise<void>
- Defined in sqlite-advanced.ts:229

createBeforeUpdateTrigger

createBeforeUpdateTrigger(
    triggerName: string,
    tableName: string,
    body: string,
): Promise<void>
Create a BEFORE UPDATE trigger
Parameters
- triggerName: string
- tableName: string
- body: string
Returns Promise<void>
- Defined in sqlite-advanced.ts:242

createInsteadOfTrigger

createInsteadOfTrigger(
    triggerName: string,
    viewName: string,
    events: TriggerEvent[],
    body: string,
): Promise<void>
Create an INSTEAD OF trigger (for views)
Parameters
- triggerName: string
- viewName: string
- events: TriggerEvent[]
- body: string
Returns Promise<void>
- Defined in sqlite-advanced.ts:255

createRecursiveTrigger

createRecursiveTrigger(
    triggerName: string,
    tableName: string,
    insertBody: string,
    updateBody: string,
    deleteBody?: string,
): Promise<void>
Create a recursive trigger
Parameters
- triggerName: string
- tableName: string
- insertBody: string
- updateBody: string
- OptionaldeleteBody: string
Returns Promise<void>
- Defined in sqlite-advanced.ts:269

dropTrigger

dropTrigger(
triggerName: string,
options?: { ifExists?: boolean },
): Promise<void>
Drop a trigger
Parameters
- triggerName: string
- Optionaloptions: { ifExists?: boolean }
Returns Promise<void>
- Defined in sqlite-advanced.ts:302

listTriggers

listTriggers(tableName?: string): Promise<string[]>
List all triggers
Parameters
- OptionaltableName: string
Returns Promise<string[]>
- Defined in sqlite-advanced.ts:314

getTriggerDefinition

getTriggerDefinition(triggerName: string): Promise<string | null>
Get trigger definition
Parameters
- triggerName: string
Returns Promise<string | null>
- Defined in sqlite-advanced.ts:326

createFTS5Table

createFTS5Table(
    tableName: string,
    columns: { name: string; type?: string; notindexed?: boolean }[],
    options?: {
        tokenizer?:
            | FTS5Tokenizer
            | { name: FTS5Tokenizer; options?: Record<string, unknown> };
        content?: string;
        contentRowId?: string;
        prefix?: "all" | number[];
    },
): Promise<void>
Create an FTS5 virtual table for full-text search
Parameters
- tableName: string
- columns: { name: string; type?: string; notindexed?: boolean }[]
- Optionaloptions: {
      tokenizer?:
          | FTS5Tokenizer
          | { name: FTS5Tokenizer; options?: Record<string, unknown> };
      content?: string;
      contentRowId?: string;
      prefix?: "all" | number[];
  }
Returns Promise<void>
- Defined in sqlite-advanced.ts:339

createFTS5FromTable

createFTS5FromTable(
    ftsTableName: string,
    sourceTable: string,
    sourceColumns: string[],
    options?: { tokenizer?: FTS5Tokenizer },
): Promise<void>
Create FTS5 table with existing content table
Parameters
- ftsTableName: string
- sourceTable: string
- sourceColumns: string[]
- Optionaloptions: { tokenizer?: FTS5Tokenizer }
Returns Promise<void>
- Defined in sqlite-advanced.ts:400

dropFTS5Table

dropFTS5Table(
tableName: string,
options?: { ifExists?: boolean },
): Promise<void>
Drop an FTS5 table
Parameters
- tableName: string
- Optionaloptions: { ifExists?: boolean }
Returns Promise<void>
- Defined in sqlite-advanced.ts:450

fullTextSearch

fullTextSearch(
    ftsTable: string,
    searchQuery: string,
    options?: {
        columns?: string[];
        orderBy?: { column: string; desc?: boolean }[];
        limit?: number;
        offset?: number;
        highlight?: { before?: string; after?: string; column?: string };
        snippet?: {
            before?: string;
            after?: string;
            columns?: string[];
            maxTokens?: number;
        };
        bm25?: boolean;
    },
): Promise<QueryResult>
Perform full-text search
Parameters
- ftsTable: string
- searchQuery: string
- Optionaloptions: {
      columns?: string[];
      orderBy?: { column: string; desc?: boolean }[];
      limit?: number;
      offset?: number;
      highlight?: { before?: string; after?: string; column?: string };
      snippet?: {
          before?: string;
          after?: string;
          columns?: string[];
          maxTokens?: number;
      };
      bm25?: boolean;
  }
Returns Promise<QueryResult>
- Defined in sqlite-advanced.ts:462

rebuildFTS5

rebuildFTS5(tableName: string): Promise<void>
Rebuild FTS5 index
Parameters
- tableName: string
Returns Promise<void>
- Defined in sqlite-advanced.ts:510

optimizeFTS5

optimizeFTS5(tableName: string): Promise<void>
Optimize FTS5 index
Parameters
- tableName: string
Returns Promise<void>
- Defined in sqlite-advanced.ts:519

parseJson

parseJson(jsonString: string): unknown
Parse JSON string
Parameters
- jsonString: string
Returns unknown
- Defined in sqlite-advanced.ts:532

jsonExtract

jsonExtract(jsonColumn: string, path: string): string
Extract value from JSON
Parameters
- jsonColumn: string
- path: string
Returns string
- Defined in sqlite-advanced.ts:543

jsonSet

jsonSet(jsonColumn: string, path: string, value: unknown): string
Set value in JSON
Parameters
- jsonColumn: string
- path: string
- value: unknown
Returns string
- Defined in sqlite-advanced.ts:550

jsonArrayAppend

jsonArrayAppend(jsonColumn: string, path: string, value: unknown): string
Insert into JSON array
Parameters
- jsonColumn: string
- path: string
- value: unknown
Returns string
- Defined in sqlite-advanced.ts:557

jsonRemove

jsonRemove(jsonColumn: string, path: string): string
Remove from JSON
Parameters
- jsonColumn: string
- path: string
Returns string
- Defined in sqlite-advanced.ts:564

jsonArrayLength

jsonArrayLength(jsonColumn: string, path?: string): string
Get JSON array length
Parameters
- jsonColumn: string
- Optionalpath: string
Returns string
- Defined in sqlite-advanced.ts:571

jsonContains

jsonContains(jsonColumn: string, value: unknown, path?: string): string
Check if JSON contains value

Note: SQLite's JSON1 extension has no json_contains function (that name is MySQL-specific); calling this would fail at runtime with "no such function: json_contains". Emulate it with json_extract() equality instead.
Parameters
- jsonColumn: string
- value: unknown
- Optionalpath: string
Returns string
- Defined in sqlite-advanced.ts:584

jsonEach

jsonEach(jsonColumn: string, path?: string): string
Query JSON array as table
Parameters
- jsonColumn: string
- Optionalpath: string
Returns string
- Defined in sqlite-advanced.ts:592

jsonTree

jsonTree(jsonColumn: string, path?: string): string
Query JSON object as table
Parameters
- jsonColumn: string
- Optionalpath: string
Returns string
- Defined in sqlite-advanced.ts:599

jsonType

jsonType(jsonColumn: string, path?: string): string
Get JSON type
Parameters
- jsonColumn: string
- Optionalpath: string
Returns string
- Defined in sqlite-advanced.ts:606

jsonValid

jsonValid(jsonColumn: string): string
Valid JSON check
Parameters
- jsonColumn: string
Returns string
- Defined in sqlite-advanced.ts:613

jsonEachQuery

jsonEachQuery(
    jsonColumn: string,
    path?: string,
    options?: {
        key?: string;
        value?: string;
        type?: string;
        id?: string;
        parent?: string;
    },
): Promise<QueryResult>
Query using json_each (table-valued function)
Parameters
- jsonColumn: string
- Optionalpath: string
- Optionaloptions: { key?: string; value?: string; type?: string; id?: string; parent?: string }
Returns Promise<QueryResult>
- Defined in sqlite-advanced.ts:620

createTableWithGeneratedColumns

createTableWithGeneratedColumns(
    tableName: string,
    columns: {
        name: string;
        type: string;
        primaryKey?: boolean;
        notNull?: boolean;
        defaultValue?: unknown;
        generated?: { expression: string; type: GeneratedStorageType };
    }[],
): string
Create table with generated columns
Parameters
- tableName: string
- columns: {
      name: string;
      type: string;
      primaryKey?: boolean;
      notNull?: boolean;
      defaultValue?: unknown;
      generated?: { expression: string; type: GeneratedStorageType };
  }[]
Returns string
- Defined in sqlite-advanced.ts:655

createVirtualColumn

createVirtualColumn(name: string, type: string, expression: string): string
Create a VIRTUAL generated column
Parameters
- name: string
- type: string
- expression: string
Returns string
- Defined in sqlite-advanced.ts:696

createStoredColumn

createStoredColumn(name: string, type: string, expression: string): string
Create a STORED generated column
Parameters
- name: string
- type: string
- expression: string
Returns string
- Defined in sqlite-advanced.ts:703

createUniqueIndex

createUniqueIndex(
    tableName: string,
    indexName: string,
    columns: string[],
): Promise<void>
Create a UNIQUE index
Parameters
- tableName: string
- indexName: string
- columns: string[]
Returns Promise<void>
- Defined in sqlite-advanced.ts:714

createPartialIndex

createPartialIndex(
    tableName: string,
    indexName: string,
    columns: string[],
    whereCondition: string,
): Promise<void>
Create a partial index (with WHERE clause)
Parameters
- tableName: string
- indexName: string
- columns: string[]
- whereCondition: string
Returns Promise<void>
- Defined in sqlite-advanced.ts:722

createExpressionIndex

createExpressionIndex(
    tableName: string,
    indexName: string,
    expression: string,
): Promise<void>
Create an expression index
Parameters
- tableName: string
- indexName: string
- expression: string
Returns Promise<void>
- Defined in sqlite-advanced.ts:735

createIndexIfNotExists

createIndexIfNotExists(
    tableName: string,
    indexName: string,
    columns: string[],
    options?: { unique?: boolean; where?: string },
): Promise<void>
Create an index with IF NOT EXISTS
Parameters
- tableName: string
- indexName: string
- columns: string[]
- Optionaloptions: { unique?: boolean; where?: string }
Returns Promise<void>
- Defined in sqlite-advanced.ts:747

listIndexes

listIndexes(
tableName: string,
): Promise<{ name: string; unique: boolean; partial: boolean }[]>
List all indexes for a table
Parameters
- tableName: string
Returns Promise<{ name: string; unique: boolean; partial: boolean }[]>
- Defined in sqlite-advanced.ts:760

reindex

reindex(target?: string): Promise<void>
Reindex a table or database
Parameters
- Optionaltarget: string
Returns Promise<void>
- Defined in sqlite-advanced.ts:776

buildWindowFunction

buildWindowFunction(
    functionName: string,
    options?: {
        distinct?: boolean;
        filter?: string;
        over?: {
            partitionBy?: string[];
            orderBy?: { column: string; desc?: boolean }[];
            rows?: { start?: number; end?: number };
            range?: { start?: number; end?: number };
            frame?: "RANGE" | "ROWS" | "GROUPS";
        };
    },
): string
Build a window function query
Parameters
- functionName: string
- Optionaloptions: {
      distinct?: boolean;
      filter?: string;
      over?: {
          partitionBy?: string[];
          orderBy?: { column: string; desc?: boolean }[];
          rows?: { start?: number; end?: number };
          range?: { start?: number; end?: number };
          frame?: "RANGE" | "ROWS" | "GROUPS";
      };
  }
Returns string
- Defined in sqlite-advanced.ts:788

rowNumber

rowNumber(
    options?: {
        partitionBy?: string[];
        orderBy?: { column: string; desc?: boolean }[];
    },
): string
ROW_NUMBER() window function
Parameters
- Optionaloptions: { partitionBy?: string[]; orderBy?: { column: string; desc?: boolean }[] }
Returns string
- Defined in sqlite-advanced.ts:859

rank

rank(
    options?: {
        partitionBy?: string[];
        orderBy?: { column: string; desc?: boolean }[];
    },
): string
RANK() window function
Parameters
- Optionaloptions: { partitionBy?: string[]; orderBy?: { column: string; desc?: boolean }[] }
Returns string
- Defined in sqlite-advanced.ts:869

denseRank

denseRank(
    options?: {
        partitionBy?: string[];
        orderBy?: { column: string; desc?: boolean }[];
    },
): string
DENSE_RANK() window function
Parameters
- Optionaloptions: { partitionBy?: string[]; orderBy?: { column: string; desc?: boolean }[] }
Returns string
- Defined in sqlite-advanced.ts:879

ntile

ntile(
    n: number,
    options?: {
        partitionBy?: string[];
        orderBy?: { column: string; desc?: boolean }[];
    },
): string
NTILE(n) window function
Parameters
- n: number
- Optionaloptions: { partitionBy?: string[]; orderBy?: { column: string; desc?: boolean }[] }
Returns string
- Defined in sqlite-advanced.ts:889

lag

lag(column: string, offset?: number, defaultValue?: unknown): string
LAG() window function
Parameters
- column: string
- Optionaloffset: number
- OptionaldefaultValue: unknown
Returns string
- Defined in sqlite-advanced.ts:899

lead

lead(column: string, offset?: number, defaultValue?: unknown): string
LEAD() window function
Parameters
- column: string
- Optionaloffset: number
- OptionaldefaultValue: unknown
Returns string
- Defined in sqlite-advanced.ts:907

firstValue

firstValue(column: string): string
FIRST_VALUE() window function
Parameters
- column: string
Returns string
- Defined in sqlite-advanced.ts:915

lastValue

lastValue(column: string): string
LAST_VALUE() window function
Parameters
- column: string
Returns string
- Defined in sqlite-advanced.ts:922

nthValue

nthValue(column: string, n: number): string
NTH_VALUE() window function
Parameters
- column: string
- n: number
Returns string
- Defined in sqlite-advanced.ts:929

buildCTE

buildCTE(
    cteName: string,
    columns: string[],
    query: string,
    recursive?: boolean,
): string
Build a CTE query
Parameters
- cteName: string
- columns: string[]
- query: string
- Optionalrecursive: boolean
Returns string
- Defined in sqlite-advanced.ts:940

buildMultipleCTEs

buildMultipleCTEs(
    ctes: { name: string; columns?: string[]; query: string }[],
    mainQuery: string,
    recursive?: boolean,
): string
Build multiple CTEs
Parameters
- ctes: { name: string; columns?: string[]; query: string }[]
- mainQuery: string
- Optionalrecursive: boolean
Returns string
- Defined in sqlite-advanced.ts:948

executeRecursiveCTE

executeRecursiveCTE(
    cteName: string,
    baseQuery: string,
    recursiveQuery: string,
    finalQuery: string,
): Promise<QueryResult>
Execute a recursive CTE query
Parameters
- cteName: string
- baseQuery: string
- recursiveQuery: string
- finalQuery: string
Returns Promise<QueryResult>
- Defined in sqlite-advanced.ts:967

generateSequence

generateSequence(start: number, end: number): string
Recursive CTE example: Generate sequence
Parameters
- start: number
- end: number
Returns string
- Defined in sqlite-advanced.ts:980

vacuum

vacuum(
options?: { schema?: string; shrinkTo?: number; analyze?: boolean },
): Promise<void>
VACUUM the database Reclaims disk space and defragments the database
Parameters
- Optionaloptions: { schema?: string; shrinkTo?: number; analyze?: boolean }
Returns Promise<void>
- Defined in sqlite-advanced.ts:996

analyze

analyze(target?: string): Promise<void>
ANALYZE the database Updates statistics for the query optimizer
Parameters
- Optionaltarget: string
Returns Promise<void>
- Defined in sqlite-advanced.ts:1018

analyzeDetailed

analyzeDetailed(tableName?: string): Promise<QueryResult>
ANALYZE with detailed information
Parameters
- OptionaltableName: string
Returns Promise<QueryResult>
- Defined in sqlite-advanced.ts:1026

getTableStats

getTableStats(tableName: string): Promise<QueryResult>
Get table statistics
Parameters
- tableName: string
Returns Promise<QueryResult>
- Defined in sqlite-advanced.ts:1043

getIndexStats

getIndexStats(indexName: string): Promise<QueryResult>
Get index statistics
Parameters
- indexName: string
Returns Promise<QueryResult>
- Defined in sqlite-advanced.ts:1052

savepoint

savepoint(savepointName: string): Promise<void>
Create a savepoint
Parameters
- savepointName: string
Returns Promise<void>
- Defined in sqlite-advanced.ts:1065

releaseSavepoint

releaseSavepoint(savepointName: string): Promise<void>
Release a savepoint
Parameters
- savepointName: string
Returns Promise<void>
- Defined in sqlite-advanced.ts:1072

rollbackToSavepoint

rollbackToSavepoint(savepointName: string): Promise<void>
Rollback to a savepoint
Parameters
- savepointName: string
Returns Promise<void>
- Defined in sqlite-advanced.ts:1079

withSavepoint

withSavepoint<T>(savepointName: string, fn: () => Promise<T>): Promise<T>
Execute within a savepoint
Type Parameters
- T
Parameters
- savepointName: string
- fn: () => Promise<T>
Returns Promise<T>
- Defined in sqlite-advanced.ts:1086

buildUpsertQuery

buildUpsertQuery(
    tableName: string,
    columns: string[],
    conflictColumns: string[],
    updateColumns?: string[],
    options?: { ignore?: boolean; replace?: boolean },
): string
Build an UPSERT query
Parameters
- tableName: string
- columns: string[]
- conflictColumns: string[]
- OptionalupdateColumns: string[]
- Optionaloptions: { ignore?: boolean; replace?: boolean }
Returns string
- Defined in sqlite-advanced.ts:1109

upsert

upsert(
    tableName: string,
    values: Record<string, unknown>,
    conflictColumns: string[],
    updateColumns?: string[],
): Promise<QueryResult>
Perform an upsert
Parameters
- tableName: string
- values: Record<string, unknown>
- conflictColumns: string[]
- OptionalupdateColumns: string[]
Returns Promise<QueryResult>
- Defined in sqlite-advanced.ts:1140

jsonEachAsTable

jsonEachAsTable(jsonColumn: string, path?: string): Promise<QueryResult>
Use json_each as table-valued function
Parameters
- jsonColumn: string
- Optionalpath: string
Returns Promise<QueryResult>
- Defined in sqlite-advanced.ts:1159

jsonTreeAsTable

jsonTreeAsTable(jsonColumn: string, path?: string): Promise<QueryResult>
Use json_tree as table-valued function
Parameters
- jsonColumn: string
- Optionalpath: string
Returns Promise<QueryResult>
- Defined in sqlite-advanced.ts:1167

generateSeries

generateSeries(start: number, end: number, step?: number): Promise<QueryResult>
Generate series using recursive CTE
Parameters
- start: number
- end: number
- Optionalstep: number
Returns Promise<QueryResult>
- Defined in sqlite-advanced.ts:1175

fts5Search

fts5Search(ftsTable: string, query: string): Promise<QueryResult>
Use fts5 as table-valued function
Parameters
- ftsTable: string
- query: string
Returns Promise<QueryResult>
- Defined in sqlite-advanced.ts:1185

loadExtension

loadExtension(extensionPath: string): void
Load a SQLite extension
Parameters
- extensionPath: string
Returns void
- Defined in sqlite-advanced.ts:1198

setExtensionLoading

setExtensionLoading(enabled: boolean): void
Enable/disable extension loading
Parameters
- enabled: boolean
Returns void
- Defined in sqlite-advanced.ts:1206

getLoadedExtensions

getLoadedExtensions(): string[]
Get list of loaded extensions

Returns string[]
- Defined in sqlite-advanced.ts:1213

createIntegerPrimaryKey

createIntegerPrimaryKey(columnName: string, autoIncrement?: boolean): string
Create INTEGER PRIMARY KEY column definition
Parameters
- columnName: string
- OptionalautoIncrement: boolean
Returns string
- Defined in sqlite-advanced.ts:1228

createColumnWithAffinity

createColumnWithAffinity(
columnName: string,
affinity: "INTEGER" | "REAL" | "TEXT" | "BLOB" | "NUMERIC",
): string
Create column with specific affinity
Parameters
- columnName: string
- affinity: "INTEGER" | "REAL" | "TEXT" | "BLOB" | "NUMERIC"
Returns string
- Defined in sqlite-advanced.ts:1237

getColumnAffinity

getColumnAffinity(type: string): string
Get column affinity
Parameters
- type: string
Returns string
- Defined in sqlite-advanced.ts:1247

createCheckConstraint

createCheckConstraint(columnName: string, condition: string): string
Create CHECK constraint
Parameters
- columnName: string
- condition: string
Returns string
- Defined in sqlite-advanced.ts:1267

createTableWithOnConflict

createTableWithOnConflict(
    tableName: string,
    columns: { name: string; type: string; constraints?: string[] }[],
    conflictAlgorithm?: ConflictAlgorithm,
): string
Create table with ON CONFLICT clause
Parameters
- tableName: string
- columns: { name: string; type: string; constraints?: string[] }[]
- OptionalconflictAlgorithm: ConflictAlgorithm
Returns string
- Defined in sqlite-advanced.ts:1274

addOnConflictClause

addOnConflictClause(
constraint: string,
conflictAlgorithm: ConflictAlgorithm,
): string
Add ON CONFLICT to column definition
Parameters
- constraint: string
- conflictAlgorithm: ConflictAlgorithm
Returns string
- Defined in sqlite-advanced.ts:1301

createUniqueConstraint

createUniqueConstraint(columns: string[]): string
Create UNIQUE constraint
Parameters
- columns: string[]
Returns string
- Defined in sqlite-advanced.ts:1308

createNotNullConstraint

createNotNullConstraint(
columnName: string,
conflictAlgorithm?: ConflictAlgorithm,
): string
Create NOT NULL constraint with ON CONFLICT
Parameters
- columnName: string
- OptionalconflictAlgorithm: ConflictAlgorithm
Returns string
- Defined in sqlite-advanced.ts:1315

pragma

pragma(pragmaName: string, value?: unknown): Promise<QueryResult>
Execute a PRAGMA command
Parameters
- pragmaName: string
- Optionalvalue: unknown
Returns Promise<QueryResult>
- Defined in sqlite-advanced.ts:1326

getDatabaseInfo

getDatabaseInfo(): Promise<
    {
        schemaVersion: number;
        userVersion: number;
        foreignKeys: boolean;
        journalingMode: string;
        synchronous: string;
        cacheSize: number;
        pageSize: number;
    },
>
Get database info

Returns Promise<
    {
        schemaVersion: number;
        userVersion: number;
        foreignKeys: boolean;
        journalingMode: string;
        synchronous: string;
        cacheSize: number;
        pageSize: number;
    },
>
- Defined in sqlite-advanced.ts:1334

setDatabaseOptions

setDatabaseOptions(
    options: {
        foreignKeys?: boolean;
        journalingMode?:
            | "DELETE"
            | "TRUNCATE"
            | "PERSIST"
            | "MEMORY"
            | "WAL"
            | "OFF";
        synchronous?: "FULL"
        | "OFF"
        | "NORMAL"
        | "EXTRA";
        cacheSize?: number;
    },
): Promise<void>
Set database options
Parameters
- options: {
      foreignKeys?: boolean;
      journalingMode?:
          | "DELETE"
          | "TRUNCATE"
          | "PERSIST"
          | "MEMORY"
          | "WAL"
          | "OFF";
      synchronous?: "FULL"
      | "OFF"
      | "NORMAL"
      | "EXTRA";
      cacheSize?: number;
  }
Returns Promise<void>
- Defined in sqlite-advanced.ts:1367

getTableInfo

getTableInfo(tableName: string): Promise<QueryResult>
Get table info using PRAGMA
Parameters
- tableName: string
Returns Promise<QueryResult>
- Defined in sqlite-advanced.ts:1390

getIndexList

getIndexList(tableName: string): Promise<QueryResult>
Get index list for table
Parameters
- tableName: string
Returns Promise<QueryResult>
- Defined in sqlite-advanced.ts:1400

getForeignKeyList

getForeignKeyList(tableName: string): Promise<QueryResult>
Get foreign key list for table
Parameters
- tableName: string
Returns Promise<QueryResult>
- Defined in sqlite-advanced.ts:1407

escapeId

escapeId(identifier: unknown): string
Escape identifier
Parameters
- identifier: unknown
Returns string
- Defined in sqlite-advanced.ts:1418

escape

escape(value: unknown): string
Escape value
Parameters
- value: unknown
Returns string
- Defined in sqlite-advanced.ts:1434

Class SQLiteAdvanced

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SQLiteAdvanced

Methods

createView

Parameters

Returns Promise<void>

dropView

Parameters

Returns Promise<void>

listViews

Parameters

Returns Promise<string[]>

getViewDefinition

Parameters

Returns Promise<string | null>

createTrigger

Parameters

Returns Promise<void>

createAfterInsertTrigger

Parameters

Returns Promise<void>

createAfterUpdateTrigger

Parameters

Returns Promise<void>

createAfterDeleteTrigger

Parameters

Returns Promise<void>

createBeforeInsertTrigger

Parameters

Returns Promise<void>

createBeforeUpdateTrigger

Parameters

Returns Promise<void>

createInsteadOfTrigger

Parameters

Returns Promise<void>

createRecursiveTrigger

Parameters

Returns Promise<void>

dropTrigger

Parameters

Returns Promise<void>

listTriggers

Parameters

Returns Promise<string[]>

getTriggerDefinition

Parameters

Returns Promise<string | null>

createFTS5Table

Parameters

Returns Promise<void>

createFTS5FromTable

Parameters

Returns Promise<void>

dropFTS5Table

Parameters

Returns Promise<void>

fullTextSearch

Parameters

Returns Promise<QueryResult>

rebuildFTS5

Parameters

Returns Promise<void>

optimizeFTS5

Parameters

Returns Promise<void>

parseJson

Parameters

Returns unknown

jsonExtract

Parameters

Returns string

jsonSet

Parameters