From e03974c7292f005b6a2ff5a339f81c561b6c4dc1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sami=20Koskim=C3=A4ki?= Date: Thu, 16 Dec 2021 13:43:20 +0200 Subject: [PATCH] update docs --- docs/classes/AliasedQueryBuilder.html | 2 +- docs/classes/AliasedRawBuilder.html | 2 +- docs/classes/AlterColumnBuilder.html | 2 +- docs/classes/AlterTableAddColumnBuilder.html | 22 ++-- ...erTableAddForeignKeyConstraintBuilder.html | 2 +- docs/classes/AlterTableBuilder.html | 4 +- docs/classes/AlterTableExecutor.html | 2 +- .../AlterTableModifyColumnBuilder.html | 22 ++-- docs/classes/CamelCasePlugin.html | 4 +- docs/classes/ColumnDefinitionBuilder.html | 22 ++-- docs/classes/ConnectionBuilder.html | 2 +- docs/classes/CreateIndexBuilder.html | 14 +-- docs/classes/CreateSchemaBuilder.html | 2 +- docs/classes/CreateTableBuilder.html | 18 +-- docs/classes/CreateViewBuilder.html | 8 +- docs/classes/DefaultConnectionProvider.html | 2 +- docs/classes/DefaultQueryCompiler.html | 2 +- docs/classes/DefaultQueryExecutor.html | 16 +-- docs/classes/DeleteQueryBuilder.html | 68 +++++------ docs/classes/DeleteResult.html | 2 +- docs/classes/DialectAdapterBase.html | 8 +- docs/classes/DropIndexBuilder.html | 4 +- docs/classes/DropSchemaBuilder.html | 2 +- docs/classes/DropTableBuilder.html | 2 +- docs/classes/DropViewBuilder.html | 2 +- docs/classes/DynamicModule.html | 2 +- docs/classes/ExpressionBuilder.html | 6 +- docs/classes/ForeignKeyConstraintBuilder.html | 2 +- docs/classes/FunctionBuilder.html | 10 +- docs/classes/InsertQueryBuilder.html | 39 +++--- docs/classes/InsertResult.html | 2 +- docs/classes/JoinBuilder.html | 18 +-- docs/classes/Kysely.html | 38 +++--- docs/classes/Log.html | 2 +- docs/classes/MigrationModule.html | 4 +- docs/classes/MysqlAdapter.html | 8 +- docs/classes/MysqlDialect.html | 8 +- docs/classes/MysqlDriver.html | 14 +-- docs/classes/MysqlIntrospector.html | 2 +- docs/classes/MysqlQueryCompiler.html | 2 +- docs/classes/NoResultError.html | 2 +- docs/classes/NoopQueryExecutor.html | 16 +-- docs/classes/OperationNodeTransformer.html | 2 +- docs/classes/OperationNodeVisitor.html | 2 +- docs/classes/PostgresAdapter.html | 8 +- docs/classes/PostgresDialect.html | 8 +- docs/classes/PostgresDriver.html | 14 +-- docs/classes/PostgresIntrospector.html | 2 +- docs/classes/PostgresQueryCompiler.html | 2 +- docs/classes/QueryCreator.html | 14 +-- docs/classes/QueryExecutor.html | 16 +-- docs/classes/RawBuilder.html | 4 +- docs/classes/SchemaModule.html | 20 ++-- docs/classes/SelectQueryBuilder.html | 112 +++++++++--------- docs/classes/SingleConnectionProvider.html | 2 +- docs/classes/SqliteAdapter.html | 8 +- docs/classes/SqliteDialect.html | 8 +- docs/classes/SqliteDriver.html | 14 +-- docs/classes/SqliteIntrospector.html | 2 +- docs/classes/SqliteQueryCompiler.html | 2 +- docs/classes/Transaction.html | 34 +++--- docs/classes/TransactionBuilder.html | 2 +- docs/classes/UpdateQueryBuilder.html | 74 ++++++------ docs/classes/UpdateResult.html | 2 +- docs/interfaces/AddColumnNode.html | 2 +- docs/interfaces/AddConstraintNode.html | 2 +- docs/interfaces/AliasNode.html | 2 +- docs/interfaces/AlterColumnBuilderProps.html | 2 +- docs/interfaces/AlterColumnNode.html | 2 +- .../AlterTableAddColumnBuilderProps.html | 2 +- ...leAddForeignKeyConstraintBuilderProps.html | 2 +- docs/interfaces/AlterTableBuilderProps.html | 2 +- docs/interfaces/AlterTableExecutorProps.html | 2 +- .../AlterTableModifyColumnBuilderProps.html | 2 +- docs/interfaces/AlterTableNode.html | 2 +- docs/interfaces/AndNode.html | 2 +- docs/interfaces/CamelCasePluginOptions.html | 6 +- docs/interfaces/CheckConstraintNode.html | 2 +- .../ColumnDefinitionBuilderInterface.html | 22 ++-- docs/interfaces/ColumnDefinitionNode.html | 2 +- docs/interfaces/ColumnMetadata.html | 2 +- docs/interfaces/ColumnNode.html | 2 +- docs/interfaces/ColumnUpdateNode.html | 2 +- .../interfaces/CommonTableExpressionNode.html | 2 +- docs/interfaces/Compilable.html | 2 +- docs/interfaces/CompiledQuery.html | 2 +- docs/interfaces/ConnectionProvider.html | 2 +- docs/interfaces/CreateIndexBuilderProps.html | 2 +- docs/interfaces/CreateIndexNode.html | 2 +- docs/interfaces/CreateSchemaBuilderProps.html | 2 +- docs/interfaces/CreateSchemaNode.html | 2 +- docs/interfaces/CreateTableBuilderProps.html | 2 +- docs/interfaces/CreateTableNode.html | 2 +- docs/interfaces/CreateViewBuilderProps.html | 2 +- docs/interfaces/CreateViewNode.html | 2 +- docs/interfaces/DataTypeNode.html | 2 +- docs/interfaces/DatabaseConnection.html | 2 +- docs/interfaces/DatabaseIntrospector.html | 2 +- docs/interfaces/DatabaseMetadata.html | 2 +- docs/interfaces/DatabaseMetadataOptions.html | 2 +- docs/interfaces/DefaultValueNode.html | 2 +- docs/interfaces/DeleteQueryBuilderProps.html | 2 +- docs/interfaces/DeleteQueryNode.html | 2 +- docs/interfaces/Dialect.html | 8 +- docs/interfaces/DialectAdapter.html | 8 +- docs/interfaces/Driver.html | 14 +-- docs/interfaces/DropColumnNode.html | 2 +- docs/interfaces/DropConstraintNode.html | 2 +- docs/interfaces/DropIndexBuilderProps.html | 2 +- docs/interfaces/DropIndexNode.html | 2 +- docs/interfaces/DropSchemaBuilderProps.html | 2 +- docs/interfaces/DropSchemaNode.html | 2 +- docs/interfaces/DropTableBuilderProps.html | 2 +- docs/interfaces/DropTableNode.html | 2 +- docs/interfaces/DropViewBuilderProps.html | 2 +- docs/interfaces/DropViewNode.html | 2 +- docs/interfaces/ErrorLogEvent.html | 2 +- docs/interfaces/ExpressionBuilderProps.html | 2 +- docs/interfaces/FilterNode.html | 2 +- .../ForeignKeyConstraintBuilderInterface.html | 2 +- docs/interfaces/ForeignKeyConstraintNode.html | 2 +- docs/interfaces/FromNode.html | 2 +- docs/interfaces/FunctionBuilderProps.html | 2 +- docs/interfaces/GeneratedAlwaysAsNode.html | 2 +- docs/interfaces/GroupByItemNode.html | 2 +- docs/interfaces/GroupByNode.html | 2 +- docs/interfaces/HavingInterface.html | 16 +-- docs/interfaces/HavingNode.html | 2 +- docs/interfaces/IdentifierNode.html | 2 +- docs/interfaces/InsertQueryBuilderProps.html | 2 +- docs/interfaces/InsertQueryNode.html | 2 +- docs/interfaces/JoinBuilderProps.html | 2 +- docs/interfaces/JoinInterface.html | 19 ++- docs/interfaces/JoinNode.html | 2 +- docs/interfaces/KyselyConfig.html | 4 +- docs/interfaces/KyselyPlugin.html | 4 +- docs/interfaces/KyselyProps.html | 2 +- docs/interfaces/LimitNode.html | 2 +- docs/interfaces/ListNode.html | 2 +- docs/interfaces/Migration.html | 2 +- docs/interfaces/ModifyColumnNode.html | 2 +- docs/interfaces/MysqlDialectConfig.html | 60 +++++----- docs/interfaces/MysqlSslOptions.html | 16 +-- docs/interfaces/OffsetNode.html | 2 +- docs/interfaces/OnConflictNode.html | 2 +- docs/interfaces/OnDuplicateKeyNode.html | 2 +- docs/interfaces/OnNode.html | 2 +- docs/interfaces/OperationNode.html | 2 +- docs/interfaces/OperationNodeSource.html | 2 +- docs/interfaces/OperatorNode.html | 2 +- docs/interfaces/OrNode.html | 2 +- docs/interfaces/OrderByItemNode.html | 2 +- docs/interfaces/OrderByNode.html | 2 +- docs/interfaces/ParensNode.html | 2 +- docs/interfaces/PluginTransformQueryArgs.html | 2 +- .../interfaces/PluginTransformResultArgs.html | 2 +- docs/interfaces/PostgresDialectConfig.html | 34 +++--- docs/interfaces/PrimaryKeyConstraintNode.html | 2 +- docs/interfaces/PrimitiveValueListNode.html | 2 +- docs/interfaces/QueryCompiler.html | 2 +- docs/interfaces/QueryCreatorProps.html | 2 +- docs/interfaces/QueryLogEvent.html | 2 +- docs/interfaces/QueryResult.html | 6 +- docs/interfaces/RawBuilderProps.html | 2 +- docs/interfaces/RawNode.html | 2 +- docs/interfaces/ReferenceNode.html | 2 +- docs/interfaces/ReferencesNode.html | 2 +- docs/interfaces/RenameColumnNode.html | 2 +- docs/interfaces/ReturningInterface.html | 4 +- docs/interfaces/ReturningNode.html | 2 +- docs/interfaces/SelectAllNode.html | 2 +- docs/interfaces/SelectQueryBuilderProps.html | 2 +- docs/interfaces/SelectQueryNode.html | 2 +- docs/interfaces/SelectionNode.html | 2 +- docs/interfaces/SqliteDialectConfig.html | 12 +- docs/interfaces/TableMetadata.html | 2 +- docs/interfaces/TableNode.html | 2 +- docs/interfaces/TransactionSettings.html | 2 +- docs/interfaces/UnionNode.html | 2 +- docs/interfaces/UniqueConstraintNode.html | 2 +- docs/interfaces/UpdateQueryBuilderProps.html | 2 +- docs/interfaces/UpdateQueryNode.html | 2 +- docs/interfaces/ValueListNode.html | 2 +- docs/interfaces/ValueNode.html | 2 +- docs/interfaces/ValuesNode.html | 2 +- docs/interfaces/WhereInterface.html | 25 ++-- docs/interfaces/WhereNode.html | 2 +- docs/interfaces/WithNode.html | 2 +- docs/modules.html | 4 +- package.json | 2 +- scripts/copy-interface-documentation.js | 2 + src/query-builder/insert-query-builder.ts | 7 +- src/query-builder/update-query-builder.ts | 4 +- 193 files changed, 616 insertions(+), 640 deletions(-) diff --git a/docs/classes/AliasedQueryBuilder.html b/docs/classes/AliasedQueryBuilder.html index edac08ad9..32d77eac4 100644 --- a/docs/classes/AliasedQueryBuilder.html +++ b/docs/classes/AliasedQueryBuilder.html @@ -1,3 +1,3 @@ AliasedQueryBuilder | kysely
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AliasedQueryBuilder<DB, TB, O, A>

SelectQueryBuilder with an alias. The result of calling SelectQueryBuilder.as.

-

Type parameters

  • DB

  • TB: keyof DB

  • O = undefined

  • A: string = never

Hierarchy

  • AliasedQueryBuilder

Index

Constructors

Methods

Constructors

constructor

Methods

toOperationNode

  • toOperationNode(): AliasNode

Generated using TypeDoc

\ No newline at end of file +

Type parameters

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

toOperationNode

  • toOperationNode(): AliasNode

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/AliasedRawBuilder.html b/docs/classes/AliasedRawBuilder.html index fa25bfe4c..a73cbae65 100644 --- a/docs/classes/AliasedRawBuilder.html +++ b/docs/classes/AliasedRawBuilder.html @@ -1,3 +1,3 @@ AliasedRawBuilder | kysely
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AliasedRawBuilder<O, A>

RawBuilder with an alias. The result of calling RawBuilder.as.

-

Type parameters

  • O = unknown

  • A: string = never

Hierarchy

  • AliasedRawBuilder

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

toOperationNode

  • toOperationNode(): AliasNode

Generated using TypeDoc

\ No newline at end of file +

Type parameters

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

toOperationNode

  • toOperationNode(): AliasNode

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/AlterColumnBuilder.html b/docs/classes/AlterColumnBuilder.html index 068a5d416..933c66345 100644 --- a/docs/classes/AlterColumnBuilder.html +++ b/docs/classes/AlterColumnBuilder.html @@ -1 +1 @@ -AlterColumnBuilder | kysely
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AlterColumnBuilder

Hierarchy

  • AlterColumnBuilder

Index

Constructors

Methods

Constructors

constructor

Methods

dropDefault

dropNotNull

setDataType

setDefault

setNotNull

Generated using TypeDoc

\ No newline at end of file +AlterColumnBuilder | kysely
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AlterColumnBuilder

Hierarchy

  • AlterColumnBuilder

Index

Constructors

Methods

Constructors

constructor

Methods

dropDefault

dropNotNull

setDataType

setDefault

setNotNull

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/AlterTableAddColumnBuilder.html b/docs/classes/AlterTableAddColumnBuilder.html index 5826a02cb..f679a1d08 100644 --- a/docs/classes/AlterTableAddColumnBuilder.html +++ b/docs/classes/AlterTableAddColumnBuilder.html @@ -1,9 +1,9 @@ -AlterTableAddColumnBuilder | kysely
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AlterTableAddColumnBuilder

Hierarchy

  • AlterTableAddColumnBuilder

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

autoIncrement

renameColumn

renameTo

setSchema

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/AlterTableExecutor.html b/docs/classes/AlterTableExecutor.html index 2b81cdabe..6a86f151f 100644 --- a/docs/classes/AlterTableExecutor.html +++ b/docs/classes/AlterTableExecutor.html @@ -1 +1 @@ -AlterTableExecutor | kysely
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AlterTableExecutor

Hierarchy

  • AlterTableExecutor

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

compile

execute

  • execute(): Promise<void>

toOperationNode

  • toOperationNode(): AlterTableNode

Generated using TypeDoc

\ No newline at end of file +AlterTableExecutor | kysely
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AlterTableExecutor

Hierarchy

  • AlterTableExecutor

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

compile

execute

  • execute(): Promise<void>

toOperationNode

  • toOperationNode(): AlterTableNode

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/AlterTableModifyColumnBuilder.html b/docs/classes/AlterTableModifyColumnBuilder.html index a41115ae0..0b188565b 100644 --- a/docs/classes/AlterTableModifyColumnBuilder.html +++ b/docs/classes/AlterTableModifyColumnBuilder.html @@ -1,9 +1,9 @@ -AlterTableModifyColumnBuilder | kysely
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AlterTableModifyColumnBuilder

Hierarchy

  • AlterTableModifyColumnBuilder

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

autoIncrement

Hierarchy

  • CamelCasePlugin

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

Protected camelCase

  • camelCase(str: string): string

Protected mapRow

Protected snakeCase

  • snakeCase(str: string): string

transformQuery

Hierarchy

  • CamelCasePlugin

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

Protected camelCase

  • camelCase(str: string): string

Protected mapRow

Protected snakeCase

  • snakeCase(str: string): string

transformQuery

transformResult

transformResult