SpatiaLiteQueryRunner

Extends

• SqliteQueryRunner

Constructors

new SpatiaLiteQueryRunner()

new SpatiaLiteQueryRunner(driver): SpatiaLiteQueryRunner

Parameters

Parameter	Type
driver	SqliteDriver

Returns

SpatiaLiteQueryRunner

Inherited from

SqliteQueryRunner.constructor

Properties

broadcaster

broadcaster: Broadcaster;

Broadcaster used on this query runner to broadcast entity events.

Inherited from

SqliteQueryRunner.broadcaster

---

connection

connection: DataSource;

Connection used by this query runner.

Inherited from

SqliteQueryRunner.connection

---

data

data: object;

Stores temporarily user data. Useful for sharing data with subscribers.

Inherited from

SqliteQueryRunner.data

---

databaseConnection

protected databaseConnection: any;

Real database connection from a connection pool used to perform queries.

Inherited from

SqliteQueryRunner.databaseConnection

---

driver

driver: SqliteDriver;

Database driver used by connection.

Inherited from

SqliteQueryRunner.driver

---

isReleased

isReleased: boolean;

Indicates if connection for this query runner is released. Once its released, query runner cannot run queries anymore.

Inherited from

SqliteQueryRunner.isReleased

---

isTransactionActive

isTransactionActive: boolean;

Indicates if transaction is in progress.

Inherited from

SqliteQueryRunner.isTransactionActive

---

loadedTables

loadedTables: Table[];

All synchronized tables in the database.

Inherited from

SqliteQueryRunner.loadedTables

---

loadedViews

loadedViews: View[];

All synchronized views in the database.

Inherited from

SqliteQueryRunner.loadedViews

---

manager

manager: EntityManager;

Entity manager working only with current query runner.

Inherited from

SqliteQueryRunner.manager

---

mode

protected mode: ReplicationMode;

Mode in which query runner executes. Used for replication. If replication is not setup its value is ignored.

Inherited from

SqliteQueryRunner.mode

---

sqlInMemory

protected sqlInMemory: SqlInMemory;

Sql-s stored if "sql in memory" mode is enabled.

Inherited from

SqliteQueryRunner.sqlInMemory

---

sqlMemoryMode

protected sqlMemoryMode: boolean;

Indicates if special query runner mode in which sql queries won't be executed is enabled.

Inherited from

SqliteQueryRunner.sqlMemoryMode

---

transactionDepth

protected transactionDepth: number;

current depth of transaction. for transactionDepth > 0 will use SAVEPOINT to start and commit/rollback transaction blocks

Inherited from

SqliteQueryRunner.transactionDepth

---

transactionPromise

protected transactionPromise: null | Promise<any>;

Inherited from

SqliteQueryRunner.transactionPromise

Methods

addColumn()

addColumn(tableOrName, column): Promise<void>

Creates a new column from the column in the table.

Parameters

Parameter	Type
tableOrName	string | Table
column	TableColumn

Returns

Promise<void>

Inherited from

SqliteQueryRunner.addColumn

---

addColumns()

addColumns(tableOrName, columns): Promise<void>

Creates a new columns from the column in the table.

Parameters

Parameter	Type
tableOrName	string | Table
columns	TableColumn[]

Returns

Promise<void>

Inherited from

SqliteQueryRunner.addColumns

---

addSpatialColumn()

addSpatialColumn(
   tableName, 
   columnName, 
   geometryType, 
allowNull): Promise<void>

Adds a spatial column to a table using Spatialite.

Parameters

Parameter	Type	Default value
tableName	string	undefined
columnName	string	undefined
geometryType	GeometryType	undefined
allowNull	boolean	false

Returns

Promise<void>

See

isSpatialColumnPresent to check if a column already exists.

---

afterMigration()

afterMigration(): Promise<void>

Called after migrations are run.

Returns

Promise<void>

Inherited from

SqliteQueryRunner.afterMigration

---

beforeMigration()

beforeMigration(): Promise<void>

Called before migrations are run.

Returns

Promise<void>

Inherited from

SqliteQueryRunner.beforeMigration

---

buildCreateColumnSql()

protected buildCreateColumnSql(column, skipPrimary?): string

Builds a query for create column.

Parameters

Parameter	Type
column	TableColumn
skipPrimary?	boolean

Returns

string

Inherited from

SqliteQueryRunner.buildCreateColumnSql

---

changeColumn()

changeColumn(
   tableOrName, 
   oldTableColumnOrName, 
newColumn): Promise<void>

Changes a column in the table.

Parameters

Parameter	Type
tableOrName	string | Table
oldTableColumnOrName	string | TableColumn
newColumn	TableColumn

Returns

Promise<void>

Inherited from

SqliteQueryRunner.changeColumn

---

changeColumns()

changeColumns(tableOrName, changedColumns): Promise<void>

Changes a column in the table. Changed column looses all its keys in the db.

Parameters

Parameter	Type
tableOrName	string | Table
changedColumns	object[]

Returns

Promise<void>

Inherited from

SqliteQueryRunner.changeColumns

---

changeTableComment()

changeTableComment(tableOrName, comment?): Promise<void>

Change table comment.

Parameters

Parameter	Type
tableOrName	string | Table
comment?	string

Returns

Promise<void>

Inherited from

SqliteQueryRunner.changeTableComment

---

clearDatabase()

clearDatabase(database?): Promise<void>

Removes all tables from the currently connected database.

Parameters

Parameter	Type
database?	string

Returns

Promise<void>

Inherited from

SqliteQueryRunner.clearDatabase

---

clearSqlMemory()

clearSqlMemory(): void

Flushes all memorized sqls.

Returns

void

Inherited from

SqliteQueryRunner.clearSqlMemory

---

clearTable()

clearTable(tableName): Promise<void>

Clears all table contents. Note: this operation uses SQL's TRUNCATE query which cannot be reverted in transactions.

Parameters

Parameter	Type
tableName	string

Returns

Promise<void>

Inherited from

SqliteQueryRunner.clearTable

---

commitTransaction()

commitTransaction(): Promise<void>

Commits transaction. Error will be thrown if transaction was not started.

Returns

Promise<void>

Inherited from

SqliteQueryRunner.commitTransaction

---

connect()

connect(): Promise<any>

Creates/uses database connection from the connection pool to perform further operations. Returns obtained database connection.

Returns

Promise<any>

Inherited from

SqliteQueryRunner.connect

---

createCheckConstraint()

createCheckConstraint(tableOrName, checkConstraint): Promise<void>

Creates new check constraint.

Parameters

Parameter	Type
tableOrName	string | Table
checkConstraint	TableCheck

Returns

Promise<void>

Inherited from

SqliteQueryRunner.createCheckConstraint

---

createCheckConstraints()

createCheckConstraints(tableOrName, checkConstraints): Promise<void>

Creates new check constraints.

Parameters

Parameter	Type
tableOrName	string | Table
checkConstraints	TableCheck[]

Returns

Promise<void>

Inherited from

SqliteQueryRunner.createCheckConstraints

---

createDatabase()

createDatabase(database, ifNotExist?): Promise<void>

Creates a new database.

Parameters

Parameter	Type
database	string
ifNotExist?	boolean

Returns

Promise<void>

Inherited from

SqliteQueryRunner.createDatabase

---

createExclusionConstraint()

createExclusionConstraint(tableOrName, exclusionConstraint): Promise<void>

Creates a new exclusion constraint.

Parameters

Parameter	Type
tableOrName	string | Table
exclusionConstraint	TableExclusion

Returns

Promise<void>

Inherited from

SqliteQueryRunner.createExclusionConstraint

---

createExclusionConstraints()

createExclusionConstraints(tableOrName, exclusionConstraints): Promise<void>

Creates a new exclusion constraints.

Parameters

Parameter	Type
tableOrName	string | Table
exclusionConstraints	TableExclusion[]

Returns

Promise<void>

Inherited from

SqliteQueryRunner.createExclusionConstraints

---

createForeignKey()

createForeignKey(tableOrName, foreignKey): Promise<void>

Creates a new foreign key.

Parameters

Parameter	Type
tableOrName	string | Table
foreignKey	TableForeignKey

Returns

Promise<void>

Inherited from

SqliteQueryRunner.createForeignKey

---

createForeignKeys()

createForeignKeys(tableOrName, foreignKeys): Promise<void>

Creates a new foreign keys.

Parameters

Parameter	Type
tableOrName	string | Table
foreignKeys	TableForeignKey[]

Returns

Promise<void>

Inherited from

SqliteQueryRunner.createForeignKeys

---

createIndex()

createIndex(tableOrName, index): Promise<void>

Creates a new index.

Parameters

Parameter	Type
tableOrName	string | Table
index	TableIndex

Returns

Promise<void>

Inherited from

SqliteQueryRunner.createIndex

---

createIndexSql()

protected createIndexSql(table, index): Query

Builds create index sql.

Parameters

Parameter	Type
table	Table
index	TableIndex

Returns

Query

Inherited from

SqliteQueryRunner.createIndexSql

---

createIndices()

createIndices(tableOrName, indices): Promise<void>

Creates a new indices

Parameters

Parameter	Type
tableOrName	string | Table
indices	TableIndex[]

Returns

Promise<void>

Inherited from

SqliteQueryRunner.createIndices

---

createPrimaryKey()

createPrimaryKey(tableOrName, columnNames): Promise<void>

Creates a new primary key.

Parameters

Parameter	Type
tableOrName	string | Table
columnNames	string[]

Returns

Promise<void>

Inherited from

SqliteQueryRunner.createPrimaryKey

---

createSchema()

createSchema(schemaPath, ifNotExist?): Promise<void>

Creates a new table schema.

Parameters

Parameter	Type
schemaPath	string
ifNotExist?	boolean

Returns

Promise<void>

Inherited from

SqliteQueryRunner.createSchema

---

createTable()

createTable(initialTable): Promise<void>

Creates a new table.

Parameters

Parameter	Type
initialTable	Table

Returns

Promise<void>

Overrides

SqliteQueryRunner.createTable

---

createTableSql()

protected createTableSql(
   table, 
   createForeignKeys?, 
   temporaryTable?): Query

Builds create table sql.

Parameters

Parameter	Type
table	Table
createForeignKeys?	boolean
temporaryTable?	boolean

Returns

Query

Inherited from

SqliteQueryRunner.createTableSql

---

createUniqueConstraint()

createUniqueConstraint(tableOrName, uniqueConstraint): Promise<void>

Creates a new unique constraint.

Parameters

Parameter	Type
tableOrName	string | Table
uniqueConstraint	TableUnique

Returns

Promise<void>

Inherited from

SqliteQueryRunner.createUniqueConstraint

---

createUniqueConstraints()

createUniqueConstraints(tableOrName, uniqueConstraints): Promise<void>

Creates a new unique constraints.

Parameters

Parameter	Type
tableOrName	string | Table
uniqueConstraints	TableUnique[]

Returns

Promise<void>

Inherited from

SqliteQueryRunner.createUniqueConstraints

---

createView()

createView(view, syncWithMetadata?): Promise<void>

Creates a new view.

Parameters

Parameter	Type
view	View
syncWithMetadata?	boolean

Returns

Promise<void>

Inherited from

SqliteQueryRunner.createView

---

createViewSql()

protected createViewSql(view): Query

Parameters

Parameter	Type
view	View

Returns

Query

Inherited from

SqliteQueryRunner.createViewSql

---

deleteTypeormMetadataSql()

protected deleteTypeormMetadataSql(__namedParameters): Query

Generates SQL query to delete a record from typeorm metadata table.

Parameters

Parameter	Type
__namedParameters	object
__namedParameters.database?	string
__namedParameters.name	string
__namedParameters.schema?	string
__namedParameters.table?	string
__namedParameters.type	MetadataTableType

Returns

Query

Inherited from

SqliteQueryRunner.deleteTypeormMetadataSql

---

deleteViewDefinitionSql()

protected deleteViewDefinitionSql(viewOrPath): Query

Builds remove view sql.

Parameters

Parameter	Type
viewOrPath	string | View

Returns

Query

Inherited from

SqliteQueryRunner.deleteViewDefinitionSql

---

disableSqlMemory()

disableSqlMemory(): void

Disables special query runner mode in which sql queries won't be executed started by calling enableSqlMemory() method.

Previously memorized sql will be flushed.

Returns

void

Inherited from

SqliteQueryRunner.disableSqlMemory

---

dropCheckConstraint()

dropCheckConstraint(tableOrName, checkOrName): Promise<void>

Drops check constraint.

Parameters

Parameter	Type
tableOrName	string | Table
checkOrName	string | TableCheck

Returns

Promise<void>

Inherited from

SqliteQueryRunner.dropCheckConstraint

---

dropCheckConstraints()

dropCheckConstraints(tableOrName, checkConstraints): Promise<void>

Drops check constraints.

Parameters

Parameter	Type
tableOrName	string | Table
checkConstraints	TableCheck[]

Returns

Promise<void>

Inherited from

SqliteQueryRunner.dropCheckConstraints

---

dropColumn()

dropColumn(tableOrName, columnOrName): Promise<void>

Drops column in the table.

Parameters

Parameter	Type
tableOrName	string | Table
columnOrName	string | TableColumn

Returns

Promise<void>

Inherited from

SqliteQueryRunner.dropColumn

---

dropColumns()

dropColumns(tableOrName, columns): Promise<void>

Drops the columns in the table.

Parameters

Parameter	Type
tableOrName	string | Table
columns	string[] | TableColumn[]

Returns

Promise<void>

Inherited from

SqliteQueryRunner.dropColumns

---

dropDatabase()

dropDatabase(database, ifExist?): Promise<void>

Drops database.

Parameters

Parameter	Type
database	string
ifExist?	boolean

Returns

Promise<void>

Inherited from

SqliteQueryRunner.dropDatabase

---

dropExclusionConstraint()

dropExclusionConstraint(tableOrName, exclusionOrName): Promise<void>

Drops exclusion constraint.

Parameters

Parameter	Type
tableOrName	string | Table
exclusionOrName	string | TableExclusion

Returns

Promise<void>

Inherited from

SqliteQueryRunner.dropExclusionConstraint

---

dropExclusionConstraints()

dropExclusionConstraints(tableOrName, exclusionConstraints): Promise<void>

Drops exclusion constraints.

Parameters

Parameter	Type
tableOrName	string | Table
exclusionConstraints	TableExclusion[]

Returns

Promise<void>

Inherited from

SqliteQueryRunner.dropExclusionConstraints

---

dropForeignKey()

dropForeignKey(tableOrName, foreignKeyOrName): Promise<void>

Drops a foreign key from the table.

Parameters

Parameter	Type
tableOrName	string | Table
foreignKeyOrName	string | TableForeignKey

Returns

Promise<void>

Inherited from

SqliteQueryRunner.dropForeignKey

---

dropForeignKeys()

dropForeignKeys(tableOrName, foreignKeys): Promise<void>

Drops a foreign keys from the table.

Parameters

Parameter	Type
tableOrName	string | Table
foreignKeys	TableForeignKey[]

Returns

Promise<void>

Inherited from

SqliteQueryRunner.dropForeignKeys

---

dropIndex()

dropIndex(tableOrName, indexOrName): Promise<void>

Drops an index from the table.

Parameters

Parameter	Type
tableOrName	string | Table
indexOrName	string | TableIndex

Returns

Promise<void>

Inherited from

SqliteQueryRunner.dropIndex

---

dropIndexSql()

protected dropIndexSql(indexOrName): Query

Builds drop index sql.

Parameters

Parameter	Type
indexOrName	string | TableIndex

Returns

Query

Inherited from

SqliteQueryRunner.dropIndexSql

---

dropIndices()

dropIndices(tableOrName, indices): Promise<void>

Drops an indices from the table.

Parameters

Parameter	Type
tableOrName	string | Table
indices	TableIndex[]

Returns

Promise<void>

Inherited from

SqliteQueryRunner.dropIndices

---

dropPrimaryKey()

dropPrimaryKey(tableOrName): Promise<void>

Drops a primary key.

Parameters

Parameter	Type
tableOrName	string | Table

Returns

Promise<void>

Inherited from

SqliteQueryRunner.dropPrimaryKey

---

dropSchema()

dropSchema(schemaPath, ifExist?): Promise<void>

Drops table schema.

Parameters

Parameter	Type
schemaPath	string
ifExist?	boolean

Returns

Promise<void>

Inherited from

SqliteQueryRunner.dropSchema

---

dropTable()

dropTable(
   tableOrName, 
   ifExist?, 
   dropForeignKeys?, 
dropIndices?): Promise<void>

Drops the table.

Parameters

Parameter	Type
tableOrName	string | Table
ifExist?	boolean
dropForeignKeys?	boolean
dropIndices?	boolean

Returns

Promise<void>

Inherited from

SqliteQueryRunner.dropTable

---

dropTableSql()

protected dropTableSql(tableOrName, ifExist?): Query

Builds drop table sql.

Parameters

Parameter	Type
tableOrName	string | Table
ifExist?	boolean

Returns

Query

Inherited from

SqliteQueryRunner.dropTableSql

---

dropUniqueConstraint()

dropUniqueConstraint(tableOrName, uniqueOrName): Promise<void>

Drops an unique constraint.

Parameters

Parameter	Type
tableOrName	string | Table
uniqueOrName	string | TableUnique

Returns

Promise<void>

Inherited from

SqliteQueryRunner.dropUniqueConstraint

---

dropUniqueConstraints()

dropUniqueConstraints(tableOrName, uniqueConstraints): Promise<void>

Creates an unique constraints.

Parameters

Parameter	Type
tableOrName	string | Table
uniqueConstraints	TableUnique[]

Returns

Promise<void>

Inherited from

SqliteQueryRunner.dropUniqueConstraints

---

dropView()

dropView(target): Promise<void>

Drops the view.

Parameters

Parameter	Type
target	string | View

Returns

Promise<void>

Inherited from

SqliteQueryRunner.dropView

---

dropViewSql()

protected dropViewSql(viewOrPath): Query

Builds drop view sql.

Parameters

Parameter	Type
viewOrPath	string | View

Returns

Query

Inherited from

SqliteQueryRunner.dropViewSql

---

enableSqlMemory()

enableSqlMemory(): void

Enables special query runner mode in which sql queries won't be executed, instead they will be memorized into a special variable inside query runner. You can get memorized sql using getMemorySql() method.

Returns

void

Inherited from

SqliteQueryRunner.enableSqlMemory

---

escapePath()

protected escapePath(target, disableEscape?): string

Escapes given table or view path. Tolerates leading/trailing dots

Parameters

Parameter	Type
target	string | Table | View
disableEscape?	boolean

Returns

string

Inherited from

SqliteQueryRunner.escapePath

---

executeMemoryDownSql()

executeMemoryDownSql(): Promise<void>

Executes down sql queries.

Returns

Promise<void>

Inherited from

SqliteQueryRunner.executeMemoryDownSql

---

executeMemoryUpSql()

executeMemoryUpSql(): Promise<void>

Executes up sql queries.

Returns

Promise<void>

Inherited from

SqliteQueryRunner.executeMemoryUpSql

---

executeQueries()

protected executeQueries(upQueries, downQueries): Promise<void>

Executes sql used special for schema build.

Parameters

Parameter	Type
upQueries	Query | Query[]
downQueries	Query | Query[]

Returns

Promise<void>

Inherited from

SqliteQueryRunner.executeQueries

---

generateIndexName()

protected generateIndexName(table, index): string

Generated an index name for a table and index

Parameters

Parameter	Type
table	Table | View
index	TableIndex

Returns

string

Inherited from

SqliteQueryRunner.generateIndexName

---

getCachedTable()

protected getCachedTable(tableName): Promise<Table>

Gets table from previously loaded tables, otherwise loads it from database.

Parameters

Parameter	Type
tableName	string

Returns

Promise<Table>

Inherited from

SqliteQueryRunner.getCachedTable

---

getCachedView()

protected getCachedView(viewName): Promise<View>

Gets view from previously loaded views, otherwise loads it from database.

Parameters

Parameter	Type
viewName	string

Returns

Promise<View>

Inherited from

SqliteQueryRunner.getCachedView

---

getCurrentDatabase()

getCurrentDatabase(): Promise<undefined>

Loads currently using database

Returns

Promise<undefined>

Inherited from

SqliteQueryRunner.getCurrentDatabase

---

getCurrentSchema()

getCurrentSchema(): Promise<undefined>

Loads currently using database schema

Returns

Promise<undefined>

Inherited from

SqliteQueryRunner.getCurrentSchema

---

getDatabases()

getDatabases(): Promise<string[]>

Returns all available database names including system databases.

Returns

Promise<string[]>

Inherited from

SqliteQueryRunner.getDatabases

---

getMemorySql()

getMemorySql(): SqlInMemory

Gets sql stored in the memory. Parameters in the sql are already replaced.

Returns

SqlInMemory

Inherited from

SqliteQueryRunner.getMemorySql

---

getReplicationMode()

getReplicationMode(): ReplicationMode

Returns

ReplicationMode

Inherited from

SqliteQueryRunner.getReplicationMode

---

getSchemas()

getSchemas(database?): Promise<string[]>

Returns all available schema names including system schemas. If database parameter specified, returns schemas of that database.

Parameters

Parameter	Type
database?	string

Returns

Promise<string[]>

Inherited from

SqliteQueryRunner.getSchemas

---

getTable()

getTable(tablePath): Promise<undefined | Table>

Loads given table's data from the database.

Parameters

Parameter	Type
tablePath	string

Returns

Promise<undefined | Table>

Inherited from

SqliteQueryRunner.getTable

---

getTablePath()

protected getTablePath(target): string

Parameters

Parameter	Type
target	| string | Table | View | TableForeignKey | EntityMetadata

Returns

string

Inherited from

SqliteQueryRunner.getTablePath

---

getTables()

getTables(tableNames?): Promise<Table[]>

Loads all tables (with given names) from the database.

Parameters

Parameter	Type
tableNames?	string[]

Returns

Promise<Table[]>

Inherited from

SqliteQueryRunner.getTables

---

getTypeormMetadataTableName()

protected getTypeormMetadataTableName(): string

Returns

string

Inherited from

SqliteQueryRunner.getTypeormMetadataTableName

---

getView()

getView(viewPath): Promise<undefined | View>

Loads given view's data from the database.

Parameters

Parameter	Type
viewPath	string

Returns

Promise<undefined | View>

Inherited from

SqliteQueryRunner.getView

---

getViews()

getViews(viewPaths?): Promise<View[]>

Loads given view's data from the database.

Parameters

Parameter	Type
viewPaths?	string[]

Returns

Promise<View[]>

Inherited from

SqliteQueryRunner.getViews

---

hasColumn()

hasColumn(tableOrName, columnName): Promise<boolean>

Checks if column with the given name exist in the given table.

Parameters

Parameter	Type
tableOrName	string | Table
columnName	string

Returns

Promise<boolean>

Inherited from

SqliteQueryRunner.hasColumn

---

hasDatabase()

hasDatabase(database): Promise<boolean>

Checks if database with the given name exist.

Parameters

Parameter	Type
database	string

Returns

Promise<boolean>

Inherited from

SqliteQueryRunner.hasDatabase

---

hasSchema()

hasSchema(schema): Promise<boolean>

Checks if schema with the given name exist.

Parameters

Parameter	Type
schema	string

Returns

Promise<boolean>

Inherited from

SqliteQueryRunner.hasSchema

---

hasTable()

hasTable(tableOrName): Promise<boolean>

Checks if table with the given name exist in the database.

Parameters

Parameter	Type
tableOrName	string | Table

Returns

Promise<boolean>

Inherited from

SqliteQueryRunner.hasTable

---

insertTypeormMetadataSql()

protected insertTypeormMetadataSql(__namedParameters): Query

Generates SQL query to insert a record into typeorm metadata table.

Parameters

Parameter	Type
__namedParameters	object
__namedParameters.database?	string
__namedParameters.name	string
__namedParameters.schema?	string
__namedParameters.table?	string
__namedParameters.type	MetadataTableType
__namedParameters.value?	string

Returns

Query

Inherited from

SqliteQueryRunner.insertTypeormMetadataSql

---

insertViewDefinitionSql()

protected insertViewDefinitionSql(view): Query

Parameters

Parameter	Type
view	View

Returns

Query

Inherited from

SqliteQueryRunner.insertViewDefinitionSql

---

isColumnChanged()

protected isColumnChanged(
   oldColumn, 
   newColumn, 
   checkDefault?, 
   checkComment?, 
   checkEnum?): boolean

Checks if at least one of column properties was changed. Does not checks column type, length and autoincrement, because these properties changes separately.

Parameters

Parameter	Type
oldColumn	TableColumn
newColumn	TableColumn
checkDefault?	boolean
checkComment?	boolean
checkEnum?	boolean

Returns

boolean

Inherited from

SqliteQueryRunner.isColumnChanged

---

isDefaultColumnLength()

protected isDefaultColumnLength(
   table, 
   column, 
   length): boolean

Checks if column length is by default.

Parameters

Parameter	Type
table	Table
column	TableColumn
length	string

Returns

boolean

Inherited from

SqliteQueryRunner.isDefaultColumnLength

---

isDefaultColumnPrecision()

protected isDefaultColumnPrecision(
   table, 
   column, 
   precision): boolean

Checks if column precision is by default.

Parameters

Parameter	Type
table	Table
column	TableColumn
precision	number

Returns

boolean

Inherited from

SqliteQueryRunner.isDefaultColumnPrecision

---

isDefaultColumnScale()

protected isDefaultColumnScale(
   table, 
   column, 
   scale): boolean

Checks if column scale is by default.

Parameters

Parameter	Type
table	Table
column	TableColumn
scale	number

Returns

boolean

Inherited from

SqliteQueryRunner.isDefaultColumnScale

---

isEnumChanged()

protected isEnumChanged(oldColumn, newColumn): boolean

Parameters

Parameter	Type
oldColumn	TableColumn
newColumn	TableColumn

Returns

boolean

Inherited from

SqliteQueryRunner.isEnumChanged

---

isSpatialColumnPresent()

isSpatialColumnPresent(tableName, columnName): Promise<boolean>

Check if a table has a spatial column.

Parameters

Parameter	Type
tableName	string
columnName	string

Returns

Promise<boolean>

---

loadPragmaRecords()

protected loadPragmaRecords(tablePath, pragma): Promise<any>

Parameters

Parameter	Type
tablePath	string
pragma	string

Returns

Promise<any>

Inherited from

SqliteQueryRunner.loadPragmaRecords

---

loadTableRecords()

protected loadTableRecords(tablePath, tableOrIndex): Promise<any>

Parameters

Parameter	Type
tablePath	string
tableOrIndex	"table" | "index"

Returns

Promise<any>

Inherited from

SqliteQueryRunner.loadTableRecords

---

loadTables()

protected loadTables(tableNames?): Promise<Table[]>

Loads all tables (with given names) from the database and creates a Table from them.

Parameters

Parameter	Type
tableNames?	string[]

Returns

Promise<Table[]>

Inherited from

SqliteQueryRunner.loadTables

---

loadViews()

protected loadViews(viewNames?): Promise<View[]>

Parameters

Parameter	Type
viewNames?	string[]

Returns

Promise<View[]>

Inherited from

SqliteQueryRunner.loadViews

---

query()

query(
   query, 
   parameters?, 
useStructuredResult?): Promise<any>

Executes a given SQL query.

Parameters

Parameter	Type
query	string
parameters?	any[]
useStructuredResult?	boolean

Returns

Promise<any>

Inherited from

SqliteQueryRunner.query

---

recreateTable()

recreateTable(
   initialNewTable, 
   initialOldTable, 
migrateData?): Promise<void>

Parameters

Parameter	Type
initialNewTable	Table
initialOldTable	Table
migrateData?	boolean

Returns

Promise<void>

Overrides

SqliteQueryRunner.recreateTable

---

release()

release(): Promise<void>

Releases used database connection. We just clear loaded tables and sql in memory, because sqlite do not support multiple connections thus query runners.

Returns

Promise<void>

Inherited from

SqliteQueryRunner.release

---

removeSpatialColumn()

removeSpatialColumn(tableName, columnName): Promise<void>

Remove patial column from a table using Spatialite.

Parameters

Parameter	Type
tableName	string
columnName	string

Returns

Promise<void>

See

isSpatialColumnPresent to check if a column already exists.

---

renameColumn()

renameColumn(
   tableOrName, 
   oldTableColumnOrName, 
newTableColumnOrName): Promise<void>

Renames column in the given table.

Parameters

Parameter	Type
tableOrName	string | Table
oldTableColumnOrName	string | TableColumn
newTableColumnOrName	string | TableColumn

Returns

Promise<void>

Inherited from

SqliteQueryRunner.renameColumn

---

renameTable()

renameTable(oldTableOrName, newTableName): Promise<void>

Renames the given table.

Parameters

Parameter	Type
oldTableOrName	string | Table
newTableName	string

Returns

Promise<void>

Inherited from

SqliteQueryRunner.renameTable

---

replaceCachedTable()

protected replaceCachedTable(table, changedTable): void

Replaces loaded table with given changed table.

Parameters

Parameter	Type
table	Table
changedTable	Table

Returns

void

Inherited from

SqliteQueryRunner.replaceCachedTable

---

rollbackTransaction()

rollbackTransaction(): Promise<void>

Rollbacks transaction. Error will be thrown if transaction was not started.

Returns

Promise<void>

Inherited from

SqliteQueryRunner.rollbackTransaction

---

selectTypeormMetadataSql()

protected selectTypeormMetadataSql(__namedParameters): Query

Generates SQL query to select record from typeorm metadata table.

Parameters

Parameter	Type
__namedParameters	object
__namedParameters.database?	string
__namedParameters.name	string
__namedParameters.schema?	string
__namedParameters.table?	string
__namedParameters.type	MetadataTableType

Returns

Query

Inherited from

SqliteQueryRunner.selectTypeormMetadataSql

---

splitTablePath()

protected splitTablePath(tablePath): [undefined | string, string]

tablePath e.g. "myDB.myTable", "myTable"

Parameters

Parameter	Type
tablePath	string

Returns

[undefined | string, string]

Inherited from

SqliteQueryRunner.splitTablePath

---

startTransaction()

startTransaction(isolationLevel?): Promise<void>

Starts transaction.

Parameters

Parameter	Type
isolationLevel?	IsolationLevel

Returns

Promise<void>

Inherited from

SqliteQueryRunner.startTransaction

---

stream()

stream(
   query, 
   parameters?, 
   onEnd?, 
onError?): Promise<ReadStream>

Returns raw data stream.

Parameters

Parameter	Type
query	string
parameters?	any[]
onEnd?	Function
onError?	Function

Returns

Promise<ReadStream>

Inherited from

SqliteQueryRunner.stream

---

updatePrimaryKeys()

updatePrimaryKeys(tableOrName, columns): Promise<void>

Updates composite primary keys.

Parameters

Parameter	Type
tableOrName	string | Table
columns	TableColumn[]

Returns

Promise<void>

Inherited from

SqliteQueryRunner.updatePrimaryKeys