@142vip.nest typeorm.类.RelationQueryBuilder

API 参考 / @142vip/nest-typeorm / RelationQueryBuilder

类: RelationQueryBuilder<Entity>

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/RelationQueryBuilder.d.ts:8

Allows to work with entity relations and perform specific operations with those relations.

todo: add transactions everywhere

theme_extends

QueryBuilder<Entity>

类型参数

Entity

Entity extends ObjectLiteral

构造函数

new RelationQueryBuilder<Entity>(queryBuilder): RelationQueryBuilder<Entity>

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:54

QueryBuilder can be initialized from given Connection and QueryRunner objects or from given other QueryBuilder.

参数

queryBuilder

QueryBuilder<any>

返回

RelationQueryBuilder<Entity>

继承自

QueryBuilder.constructor

构造函数

new RelationQueryBuilder<Entity>(connection, queryRunner?): RelationQueryBuilder<Entity>

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:58

QueryBuilder can be initialized from given Connection and QueryRunner objects or from given other QueryBuilder.

参数

connection

DataSource

queryRunner?

QueryRunner

返回

RelationQueryBuilder<Entity>

继承自

QueryBuilder.constructor

属性

@instanceof

readonly @instanceof: symbol

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/RelationQueryBuilder.d.ts:9

重写了

QueryBuilder.@instanceof

connection

readonly connection: DataSource

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:30

Connection on which QueryBuilder was created.

继承自

QueryBuilder.connection

expressionMap

readonly expressionMap: QueryExpressionMap

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:34

Contains all properties of the QueryBuilder that needs to be build a final query.

继承自

QueryBuilder.expressionMap

parentQueryBuilder

protected parentQueryBuilder: QueryBuilder<any>

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:42

If QueryBuilder was created in a subquery mode then its parent QueryBuilder (who created subquery) will be stored here.

继承自

QueryBuilder.parentQueryBuilder

queryRunner?

protected optional queryRunner?: QueryRunner

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:38

Query runner used to execute query builder query.

继承自

QueryBuilder.queryRunner

访问器

alias

Getter 签名

get alias(): string

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:67

Gets the main alias string used in this query builder.

返回

string

继承自

QueryBuilder.alias

方法

add()

add(value): Promise<void>

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/RelationQueryBuilder.d.ts:32

Adds (binds) given value to entity relation. Value can be entity, entity id or entity id map (if entity has composite ids). Value also can be array of entities, array of entity ids or array of entity id maps (if entity has composite ids). Works only for many-to-many and one-to-many relations. For many-to-one and one-to-one use #set method instead.

参数

value

any

返回

Promise<void>

addAndRemove()

addAndRemove(added, removed): Promise<void>

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/RelationQueryBuilder.d.ts:48

Adds (binds) and removes (unbinds) given values to/from entity relation. Value can be entity, entity id or entity id map (if entity has composite ids). Value also can be array of entities, array of entity ids or array of entity id maps (if entity has composite ids). Works only for many-to-many and one-to-many relations. For many-to-one and one-to-one use #set method instead.

参数

added

any

removed

any

返回

Promise<void>

addCommonTableExpression()

addCommonTableExpression(queryBuilder, alias, options?): this

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:215

Adds CTE to query

参数

queryBuilder

string | QueryBuilder<any>

alias

string

options?

QueryBuilderCteOptions

返回

this

继承自

QueryBuilder.addCommonTableExpression

callListeners()

callListeners(enabled): this

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:207

Indicates if listeners and subscribers must be called before and after query execution. Enabled by default.

参数

enabled

boolean

返回

this

继承自

QueryBuilder.callListeners

clone()

clone(): this

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:184

Clones query builder as it is. Note: it uses new query runner, if you want query builder that uses exactly same query runner, you can create query builder using its constructor, for example new SelectQueryBuilder(queryBuilder) where queryBuilder is cloned QueryBuilder.

返回

this

继承自

QueryBuilder.clone

comment()

comment(comment): this

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:190

Includes a Query comment in the query builder. This is helpful for debugging purposes, such as finding a specific query in the database server's logs, or for categorization using an APM product.

参数

comment

string

返回

this

继承自

QueryBuilder.comment

createComment()

protected createComment(): string

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:239

返回

string

继承自

QueryBuilder.createComment

createCteExpression()

protected createCteExpression(): string

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:262

返回

string

继承自

QueryBuilder.createCteExpression

createFromAlias()

protected createFromAlias(entityTarget, aliasName?): Alias

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:229

Specifies FROM which entity's table select/update/delete will be executed. Also sets a main string alias of the selection data.

参数

entityTarget

EntityTarget<any> | ((qb) => SelectQueryBuilder<any>)

aliasName?

string

返回

Alias

继承自

QueryBuilder.createFromAlias

createParameter()

protected createParameter(value): string

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:145

参数

value

any

返回

string

继承自

QueryBuilder.createParameter

createPropertyPath()

protected createPropertyPath(metadata, entity, prefix?): string[]

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:272

Creates a property paths for a given ObjectLiteral.

参数

metadata

EntityMetadata

entity

ObjectLiteral

prefix?

string

返回

string[]

继承自

QueryBuilder.createPropertyPath

createQueryBuilder()

createQueryBuilder(queryRunner?): this

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:177

Creates a completely new query builder. Uses same query runner as current QueryBuilder.

参数

queryRunner?

QueryRunner

返回

this

继承自

QueryBuilder.createQueryBuilder

createReturningExpression()

protected createReturningExpression(returningType): string

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:251

Creates "RETURNING" / "OUTPUT" expression.

参数

returningType

ReturningType

返回

string

继承自

QueryBuilder.createReturningExpression

createTimeTravelQuery()

protected createTimeTravelQuery(): string

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:243

Time travel queries for CockroachDB

返回

string

继承自

QueryBuilder.createTimeTravelQuery

createWhereClausesExpression()

protected createWhereClausesExpression(clauses): string

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:257

参数

clauses

WhereClause[]

返回

string

继承自

QueryBuilder.createWhereClausesExpression

createWhereConditionExpression()

protected createWhereConditionExpression(condition, alwaysWrap?): string

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:261

Computes given where argument - transforms to a where string all forms it can take.

参数

condition

WhereClauseCondition

alwaysWrap?

boolean

返回

string

继承自

QueryBuilder.createWhereConditionExpression

createWhereExpression()

protected createWhereExpression(): string

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:247

Creates "WHERE" expression.

返回

string

继承自

QueryBuilder.createWhereExpression

delete()

delete(): DeleteQueryBuilder<Entity>

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:106

Creates DELETE query.

返回

DeleteQueryBuilder<Entity>

继承自

QueryBuilder.delete

disableEscaping()

disableEscaping(): this

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:194

Disables escaping.

返回

this

继承自

QueryBuilder.disableEscaping

escape()

escape(name): string

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:198

Escapes table name, column name or alias name using current database's escaping character.

参数

name

string

返回

string

继承自

QueryBuilder.escape

execute()

execute(): Promise<any>

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:172

Executes sql generated by query builder and returns raw database results.

返回

Promise<any>

继承自

QueryBuilder.execute

getExistsCondition()

protected getExistsCondition(subQuery): [string, any[]]

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:267

参数

subQuery

any

返回

[string, any[]]

继承自

QueryBuilder.getExistsCondition

getMainTableName()

protected getMainTableName(): string

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:224

Gets name of the table where insert should be performed.

返回

string

继承自

QueryBuilder.getMainTableName

getParameters()

getParameters(): ObjectLiteral

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:155

Gets all parameters.

返回

ObjectLiteral

继承自

QueryBuilder.getParameters

getPredicates()

protected getPredicates(where): Generator<any[], void, unknown>

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:273

参数

where

ObjectLiteral

返回

Generator<any[], void, unknown>

继承自

QueryBuilder.getPredicates

getQuery()

getQuery(): string

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/RelationQueryBuilder.d.ts:13

Gets generated SQL query without parameters being replaced.

返回

string

重写了

QueryBuilder.getQuery

getQueryAndParameters()

getQueryAndParameters(): [string, any[]]

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:168

Gets query to be executed with all parameters used in it.

返回

[string, any[]]

继承自

QueryBuilder.getQueryAndParameters

getReturningColumns()

protected getReturningColumns(): ColumnMetadata[]

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:256

If returning / output cause is set to array of column names, then this method will return all column metadatas of those column names.

返回

ColumnMetadata[]

继承自

QueryBuilder.getReturningColumns

getSql()

getSql(): string

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:164

Gets generated sql that will be executed. Parameters in the query are escaped for the currently used driver.

返回

string

继承自

QueryBuilder.getSql

getTableName()

protected getTableName(tablePath): string

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:220

Gets escaped table name with schema name if SqlServer driver used with custom schema name, otherwise returns escaped table name.

参数

tablePath

string

返回

string

继承自

QueryBuilder.getTableName

getWhereCondition()

protected getWhereCondition(where): WhereClauseCondition

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:275

参数

where

返回

WhereClauseCondition

继承自

QueryBuilder.getWhereCondition

getWhereInIdsCondition()

protected getWhereInIdsCondition(ids): ObjectLiteral | Brackets

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:266

Creates "WHERE" condition for an in-ids condition.

参数

ids

any

返回

ObjectLiteral | Brackets

继承自

QueryBuilder.getWhereInIdsCondition

getWherePredicateCondition()

protected getWherePredicateCondition(aliasPath, parameterValue): WhereClauseCondition

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:274

参数

aliasPath

string

parameterValue

any

返回

WhereClauseCondition

继承自

QueryBuilder.getWherePredicateCondition

hasCommonTableExpressions()

protected hasCommonTableExpressions(): boolean

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:280

返回

boolean

继承自

QueryBuilder.hasCommonTableExpressions

hasParameter()

hasParameter(key): boolean

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:134

Check the existence of a parameter for this query builder.

参数

key

string

返回

boolean

继承自

QueryBuilder.hasParameter

hasRelation()

调用签名

hasRelation<T>(target, relation): boolean

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:123

Checks if given relation exists in the entity. Returns true if relation exists, false otherwise.

todo: move this method to manager? or create a shortcut?

类型参数

T

T

参数

target

EntityTarget<T>

relation

string

返回

boolean

继承自

QueryBuilder.hasRelation

调用签名

hasRelation<T>(target, relation): boolean

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:130

Checks if given relations exist in the entity. Returns true if relation exists, false otherwise.

todo: move this method to manager? or create a shortcut?

类型参数

T

T

参数

target

EntityTarget<T>

relation

string[]

返回

boolean

继承自

QueryBuilder.hasRelation

insert()

insert(): InsertQueryBuilder<Entity>

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:86

Creates INSERT query.

返回

InsertQueryBuilder<Entity>

继承自

QueryBuilder.insert

loadMany()

loadMany<T>(): Promise<T[]>

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/RelationQueryBuilder.d.ts:68

Loads many entities (relational) from the relation. You can also provide ids of relational entities to filter by.

类型参数

T

T = any

返回

Promise<T[]>

loadOne()

loadOne<T>(): Promise<T | undefined>

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/RelationQueryBuilder.d.ts:63

Loads a single entity (relational) from the relation. You can also provide id of relational entity to filter by.

类型参数

T

T = any

返回

Promise<T | undefined>

normalizeNumber()

protected normalizeNumber(num): any

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:282

参数

num

any

返回

any

继承自

QueryBuilder.normalizeNumber

obtainQueryRunner()

protected obtainQueryRunner(): QueryRunner

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:279

Creates a query builder used to execute sql queries inside this query builder.

返回

QueryRunner

继承自

QueryBuilder.obtainQueryRunner

of()

of(entity): this

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/RelationQueryBuilder.d.ts:17

Sets entity (target) which relations will be updated.

参数

entity

any

返回

this

printSql()

printSql(): this

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:159

Prints sql to stdout using console.log.

返回

this

继承自

QueryBuilder.printSql

relation()

调用签名

relation(propertyPath): RelationQueryBuilder<Entity>

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:112

Sets entity's relation with which this query builder gonna work.

参数

propertyPath

string

返回

RelationQueryBuilder<Entity>

继承自

QueryBuilder.relation

调用签名

relation<T>(entityTarget, propertyPath): RelationQueryBuilder<T>

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:116

Sets entity's relation with which this query builder gonna work.

类型参数

T

T extends ObjectLiteral

参数

entityTarget

EntityTarget<T>

propertyPath

string

返回

RelationQueryBuilder<T>

继承自

QueryBuilder.relation

remove()

remove(value): Promise<void>

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/RelationQueryBuilder.d.ts:40

Removes (unbinds) given value from entity relation. Value can be entity, entity id or entity id map (if entity has composite ids). Value also can be array of entities, array of entity ids or array of entity id maps (if entity has composite ids). Works only for many-to-many and one-to-many relations. For many-to-one and one-to-one use #set method instead.

参数

value

any

返回

Promise<void>

replacePropertyNames()

protected replacePropertyNames(statement): string

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:234

参数

statement

string

返回

string

已被弃用

this way of replace property names is too slow. Instead, we'll replace property names at the end - once query is build.

继承自

QueryBuilder.replacePropertyNames

replacePropertyNamesForTheWholeQuery()

protected replacePropertyNamesForTheWholeQuery(statement): string

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:238

Replaces all entity's propertyName to name in the given SQL string.

参数

statement

string

返回

string

继承自

QueryBuilder.replacePropertyNamesForTheWholeQuery

restore()

restore(): SoftDeleteQueryBuilder<any>

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:108

返回

SoftDeleteQueryBuilder<any>

继承自

QueryBuilder.restore

select()

调用签名

select(): SelectQueryBuilder<Entity>

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:72

Creates SELECT query. Replaces all previous selections if they exist.

返回

SelectQueryBuilder<Entity>

继承自

QueryBuilder.select

调用签名

select(selection, selectionAliasName?): SelectQueryBuilder<Entity>

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:77

Creates SELECT query and selects given data. Replaces all previous selections if they exist.

参数

selection

string

selectionAliasName?

string

返回

SelectQueryBuilder<Entity>

继承自

QueryBuilder.select

调用签名

select(selection): SelectQueryBuilder<Entity>

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:82

Creates SELECT query and selects given data. Replaces all previous selections if they exist.

参数

selection

string[]

返回

SelectQueryBuilder<Entity>

继承自

QueryBuilder.select

set()

set(value): Promise<void>

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/RelationQueryBuilder.d.ts:24

Sets entity relation's value. Value can be entity, entity id or entity id map (if entity has composite ids). Works only for many-to-one and one-to-one relations. For many-to-many and one-to-many relations use #add and #remove methods instead.

参数

value

any

返回

Promise<void>

setNativeParameters()

setNativeParameters(parameters): this

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:151

Adds native parameters from the given object.

参数

parameters

ObjectLiteral

返回

this

已被弃用

Use setParameters instead

继承自

QueryBuilder.setNativeParameters

setParameter()

setParameter(key, value): this

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:140

Sets parameter name and its value.

The key for this parameter may contain numbers, letters, underscores, or periods.

参数

key

string

value

any

返回

this

继承自

QueryBuilder.setParameter

setParameters()

setParameters(parameters): this

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:144

Adds all parameters from the given object.

参数

parameters

ObjectLiteral

返回

this

继承自

QueryBuilder.setParameters

setQueryRunner()

setQueryRunner(queryRunner): this

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:202

Sets or overrides query builder's QueryRunner.

参数

queryRunner

QueryRunner

返回

this

继承自

QueryBuilder.setQueryRunner

softDelete()

softDelete(): SoftDeleteQueryBuilder<any>

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:107

返回

SoftDeleteQueryBuilder<any>

继承自

QueryBuilder.softDelete

update()

调用签名

update(): UpdateQueryBuilder<Entity>

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:90

Creates UPDATE query and applies given update values.

返回

UpdateQueryBuilder<Entity>

继承自

QueryBuilder.update

调用签名

update(updateSet): UpdateQueryBuilder<Entity>

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:94

Creates UPDATE query and applies given update values.

参数

调用签名

update<Entity>(entity, updateSet?): UpdateQueryBuilder<Entity>

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:98

Creates UPDATE query for the given entity and applies given update values.

类型参数

Entity

Entity extends ObjectLiteral

参数

entity

EntityTarget<Entity>

updateSet?

_QueryDeepPartialEntity<ObjectLiteral extends Entity ? unknown : Entity>

返回

UpdateQueryBuilder<Entity>

继承自

QueryBuilder.update

调用签名

update(tableName, updateSet?): UpdateQueryBuilder<Entity>

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:102

Creates UPDATE query for the given table name and applies given update values.

参数

tableName

string

updateSet?

_QueryDeepPartialEntity<ObjectLiteral extends Entity ? unknown : Entity>

返回

UpdateQueryBuilder<Entity>

继承自

QueryBuilder.update

useTransaction()

useTransaction(enabled): this

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:211

If set to true the query will be wrapped into a transaction.

参数

enabled

boolean

返回

this

继承自

QueryBuilder.useTransaction

validateNumericInput()

protected validateNumericInput(label, num): number | undefined

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:287

Normalizes and validates a numeric query parameter, throwing if the result is NaN.

参数

label

string

num

number | undefined

返回

number | undefined

继承自

QueryBuilder.validateNumericInput

validateOrderByCondition()

protected validateOrderByCondition(sort): void

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:281

参数

sort

OrderByCondition

返回

void

继承自

QueryBuilder.validateOrderByCondition

registerQueryBuilderClass()

static registerQueryBuilderClass(name, factory): void

定义于: node_modules/.pnpm/typeorm@0.3.30_ioredis@5.6.0_mongodb@6.19.0_mssql@11.0.1_mysql2@3.15.1_pg@8.11.3_ts-node@10.9_6zvdq3z7xgsf663jy3j6oymho4/node_modules/typeorm/query-builder/QueryBuilder.d.ts:59

参数

name

string

factory

any

返回

void

继承自

QueryBuilder.registerQueryBuilderClass