# `class` MyConn [Documentation Index](../README.md) ```ts import {MyConn} from "https://deno.land/x/office_spirit_mysql@v0.26.1/mod.ts" ``` ## This class has - [constructor](#-constructordsn-dsn-pool-pool) - [destructor](#-symboldispose-void) - 10 properties: [dsn](#-readonly-dsn-dsn), [serverVersion](#-get-serverversion-string), [connectionId](#-get-connectionid-number), [autocommit](#-get-autocommit-boolean), [inTrx](#-get-intrx-boolean), [inTrxReadonly](#-get-intrxreadonly-boolean), [noBackslashEscapes](#-get-nobackslashescapes-boolean), [schema](#-get-schema-string), [inXa](#-get-inxa-boolean), [xaId](#-get-xaid-string) - 32 methods: [connect](#-connect-promisevoid), [end](#-end-void), [forceImmediateDisconnect](#-forceimmediatedisconnectnorollbackcurxa-booleanfalse-nokillcurquery-booleanfalse-disconnectstatus), [killQuery](#-killquery-promiseboolean), [use](#-useschema-string-void), [query](#-querycolumntypecolumnvaluesql-sqlsource-params-params-queryoptions-queryoptions-resultsetspromiserecordstring-columntype), [queryMap](#-querymapcolumntypecolumnvaluesql-sqlsource-params-params-queryoptions-queryoptions-resultsetspromisemapstring-columntype), [queryArr](#-queryarrcolumntypecolumnvaluesql-sqlsource-params-params-queryoptions-queryoptions-resultsetspromisecolumntype), [queryCol](#-querycolcolumntypecolumnvaluesql-sqlsource-params-params-queryoptions-queryoptions-resultsetspromisecolumntype), [queryVoid](#-queryvoidsql-sqlsource-params-params-queryoptions-queryoptionsvoid-promiseresultsetsvoid), [queries](#-queriescolumntypecolumnvaluesql-sqlsource-params-params-queryoptions-queryoptions-resultsetspromiserecordstring-columntype), [queriesMap](#-queriesmapcolumntypecolumnvaluesql-sqlsource-params-params-queryoptions-queryoptions-resultsetspromisemapstring-columntype), [queriesArr](#-queriesarrcolumntypecolumnvaluesql-sqlsource-params-params-queryoptions-queryoptions-resultsetspromisecolumntype), [queriesCol](#-queriescolcolumntypecolumnvaluesql-sqlsource-params-params-queryoptions-queryoptions-resultsetspromisecolumntype), [queriesVoid](#-queriesvoidsql-sqlsource-params-params-queryoptions-queryoptionsvoid-promiseresultsetsvoid), [makeLastColumnReadable](#-makelastcolumnreadablecolumntypecolumnvaluesql-sqlsource-params-params-queryoptions-queryoptions-promiseany), [prepare](#-preparecolumntypecolumnvaluesql-sqlsource-queryoptions-queryoptions-promiseresultsetsrecordstring-columntype), [prepareMap](#-preparemapcolumntypecolumnvaluesql-sqlsource-queryoptions-queryoptions-promiseresultsetsmapstring-columntype), [prepareArr](#-preparearrcolumntypecolumnvaluesql-sqlsource-queryoptions-queryoptions-promiseresultsetscolumntype), [prepareCol](#-preparecolcolumntypecolumnvaluesql-sqlsource-queryoptions-queryoptions-promiseresultsetscolumntype), [prepareVoid](#-preparevoidsql-sqlsource-queryoptions-queryoptionsvoid-promiseresultsetsvoid), [forPrepared](#-forpreparedcolumntypecolumnvalue-tunknownsql-sqlsource-callback-prepared-resultsetsrecordstring-columntype--promiset-queryoptions-queryoptions-promiset), [forPreparedMap](#-forpreparedmapcolumntypecolumnvalue-tunknownsql-sqlsource-callback-prepared-resultsetsmapstring-columntype--promiset-queryoptions-queryoptions-promiset), [forPreparedArr](#-forpreparedarrcolumntypecolumnvalue-tunknownsql-sqlsource-callback-prepared-resultsetscolumntype--promiset-queryoptions-queryoptions-promiset), [forPreparedCol](#-forpreparedcolcolumntypecolumnvalue-tunknownsql-sqlsource-callback-prepared-resultsetscolumntype--promiset-queryoptions-queryoptions-promiset), [forPreparedVoid](#-forpreparedvoidtsql-sqlsource-callback-prepared-resultsetsvoid--promiset-queryoptions-queryoptionsvoid-promiset), [startTrx](#-starttrxoptions-readonly-boolean-xaid-string-xaid1-string-promisevoid), [savepoint](#-savepoint-number), [prepareCommit](#-preparecommit-promisevoid), [rollback](#-rollbacktopointid-number-promisevoid), [commit](#-commitandchain-booleanfalse-promisevoid), [setSqlLogger](#-setsqlloggersqllogger-sqllogger--true-void) - protected property [pendingTrxSql](#-protected-pendingtrxsql-string) - [7 deprecated symbols](#-deprecated-executesql-sqlsource-params-params-queryoptions-queryoptionsvoid-promiseresultsetsvoid) #### 🔧 `constructor`(dsn: [Dsn](../class.Dsn/README.md), pool: [Pool](../class.Pool/README.md)) #### 🔨 \[Symbol.dispose](): `void` > Immediately places the connection back to it's pool where it gets eventually reset or disconnected. > This method doesn't throw. #### 📄 `readonly` dsn: [Dsn](../class.Dsn/README.md) #### 📄 `get` serverVersion(): `string` > Remote server version, as it reports (for example my server reports "8.0.25-0ubuntu0.21.04.1"). #### 📄 `get` connectionId(): `number` > Thread ID of the connection, that `SHOW PROCESSLIST` shows. #### 📄 `get` autocommit(): `boolean` > True if the connection is currently in autocommit mode. Queries like `SET autocommit=0` will affect this flag. #### 📄 `get` inTrx(): `boolean` > True if a transaction was started. Queries like `START TRANSACTION` and `ROLLBACK` will affect this flag. #### 📄 `get` inTrxReadonly(): `boolean` > True if a readonly transaction was started. Queries like `START TRANSACTION READ ONLY` and `ROLLBACK` will affect this flag. #### 📄 `get` noBackslashEscapes(): `boolean` > True, if the server is configured not to use backslash escapes in string literals. Queries like `SET sql_mode='NO_BACKSLASH_ESCAPES'` will affect this flag. #### 📄 `get` schema(): `string` > If your server version supports change schema notifications, this will be current default schema (database) name. > Queries like `USE new_schema` will affect this value. With old servers this will always remain empty string. #### 📄 `get` inXa(): `boolean` #### 📄 `get` xaId(): `string` #### ⚙ connect(): Promise\<`void`> > If end() called during connection process, the connection will not be established after this function returns. #### ⚙ end(): `void` #### ⚙ forceImmediateDisconnect(noRollbackCurXa: `boolean`=false, noKillCurQuery: `boolean`=false): DisconnectStatus > Disconnect from MySQL server, even if in the middle of query execution. > This doesn't lead to query interruption, however by default this library will reconnect to the server (or will use first new established connection to this DSN) and will issue KILL (only if the connection was in "querying" state). > Also by default this library will ROLLBACK any distributed transaction that was in prepared state (in a new connection to this DSN). > > 🎚️ Parameter **noRollbackCurXa**: > > Set to true to opt-out from automated rollback of distributed transaction. > > 🎚️ Parameter **noKillCurQuery**: > > Set to true to opt-out from automated KILL of the running query. #### ⚙ killQuery(): Promise\<`boolean`> > Send "KILL QUERY" to the server in parallel connection. > Does nothing if the connection was not established ([MyConn.connectionId](../class.MyConn/README.md#-get-connectionid-number) returns `0`). > This function doesn't throw. > > ✔️ Return value: > > `false` if couldn't connect to the server or issure the query (with respect to [Dsn.connectionTimeout](../class.Dsn/README.md#-accessor-connectiontimeout-number) and [Dsn.reconnectInterval](../class.Dsn/README.md#-accessor-reconnectinterval-number)). `true` if successfully killed, or if there was nothing to kill. #### ⚙ use(schema: `string`): `void` > Add "USE schema" command to pending. > The command will be executed together with next query. > If no query follows, the command will be never executed. > If there's no such schema, the exception will be thrown on the next query. #### ⚙ query\(sql: [SqlSource](../type.SqlSource/README.md), params?: [Params](../type.Params/README.md), queryOptions?: [QueryOptions](../private.type.QueryOptions/README.md)): [ResultsetsPromise](../class.ResultsetsPromise/README.md)\> #### ⚙ queryMap\(sql: [SqlSource](../type.SqlSource/README.md), params?: [Params](../type.Params/README.md), queryOptions?: [QueryOptions](../private.type.QueryOptions/README.md)): [ResultsetsPromise](../class.ResultsetsPromise/README.md)\> #### ⚙ queryArr\(sql: [SqlSource](../type.SqlSource/README.md), params?: [Params](../type.Params/README.md), queryOptions?: [QueryOptions](../private.type.QueryOptions/README.md)): [ResultsetsPromise](../class.ResultsetsPromise/README.md)\ #### ⚙ queryCol\(sql: [SqlSource](../type.SqlSource/README.md), params?: [Params](../type.Params/README.md), queryOptions?: [QueryOptions](../private.type.QueryOptions/README.md)): [ResultsetsPromise](../class.ResultsetsPromise/README.md)\ #### ⚙ queryVoid(sql: [SqlSource](../type.SqlSource/README.md), params?: [Params](../type.Params/README.md), queryOptions?: [QueryOptionsVoid](../private.type.QueryOptionsVoid/README.md)): Promise\<[Resultsets](../class.Resultsets/README.md)\<`void`>> #### ⚙ queries\(sql: [SqlSource](../type.SqlSource/README.md), params?: [Params](../type.Params/README.md), queryOptions?: [QueryOptions](../private.type.QueryOptions/README.md)): [ResultsetsPromise](../class.ResultsetsPromise/README.md)\> #### ⚙ queriesMap\(sql: [SqlSource](../type.SqlSource/README.md), params?: [Params](../type.Params/README.md), queryOptions?: [QueryOptions](../private.type.QueryOptions/README.md)): [ResultsetsPromise](../class.ResultsetsPromise/README.md)\> #### ⚙ queriesArr\(sql: [SqlSource](../type.SqlSource/README.md), params?: [Params](../type.Params/README.md), queryOptions?: [QueryOptions](../private.type.QueryOptions/README.md)): [ResultsetsPromise](../class.ResultsetsPromise/README.md)\ #### ⚙ queriesCol\(sql: [SqlSource](../type.SqlSource/README.md), params?: [Params](../type.Params/README.md), queryOptions?: [QueryOptions](../private.type.QueryOptions/README.md)): [ResultsetsPromise](../class.ResultsetsPromise/README.md)\ #### ⚙ queriesVoid(sql: [SqlSource](../type.SqlSource/README.md), params?: [Params](../type.Params/README.md), queryOptions?: [QueryOptionsVoid](../private.type.QueryOptionsVoid/README.md)): Promise\<[Resultsets](../class.Resultsets/README.md)\<`void`>> #### ⚙ makeLastColumnReadable\(sql: [SqlSource](../type.SqlSource/README.md), params?: [Params](../type.Params/README.md), queryOptions?: [QueryOptions](../private.type.QueryOptions/README.md)): Promise\<`any`> > Stream column contents as `ReadableStream`. If the resultset contains multiple columns, only the last one will be used (and others discarded). #### ⚙ prepare\(sql: [SqlSource](../type.SqlSource/README.md), queryOptions?: [QueryOptions](../private.type.QueryOptions/README.md)): Promise\<[Resultsets](../class.Resultsets/README.md)\>> #### ⚙ prepareMap\(sql: [SqlSource](../type.SqlSource/README.md), queryOptions?: [QueryOptions](../private.type.QueryOptions/README.md)): Promise\<[Resultsets](../class.Resultsets/README.md)\>> #### ⚙ prepareArr\(sql: [SqlSource](../type.SqlSource/README.md), queryOptions?: [QueryOptions](../private.type.QueryOptions/README.md)): Promise\<[Resultsets](../class.Resultsets/README.md)\> #### ⚙ prepareCol\(sql: [SqlSource](../type.SqlSource/README.md), queryOptions?: [QueryOptions](../private.type.QueryOptions/README.md)): Promise\<[Resultsets](../class.Resultsets/README.md)\> #### ⚙ prepareVoid(sql: [SqlSource](../type.SqlSource/README.md), queryOptions?: [QueryOptionsVoid](../private.type.QueryOptionsVoid/README.md)): Promise\<[Resultsets](../class.Resultsets/README.md)\<`void`>> #### ⚙ forPrepared\(sql: [SqlSource](../type.SqlSource/README.md), callback: (prepared: [Resultsets](../class.Resultsets/README.md)\>) => Promise\, queryOptions?: [QueryOptions](../private.type.QueryOptions/README.md)): Promise\ #### ⚙ forPreparedMap\(sql: [SqlSource](../type.SqlSource/README.md), callback: (prepared: [Resultsets](../class.Resultsets/README.md)\>) => Promise\, queryOptions?: [QueryOptions](../private.type.QueryOptions/README.md)): Promise\ #### ⚙ forPreparedArr\(sql: [SqlSource](../type.SqlSource/README.md), callback: (prepared: [Resultsets](../class.Resultsets/README.md)\) => Promise\, queryOptions?: [QueryOptions](../private.type.QueryOptions/README.md)): Promise\ #### ⚙ forPreparedCol\(sql: [SqlSource](../type.SqlSource/README.md), callback: (prepared: [Resultsets](../class.Resultsets/README.md)\) => Promise\, queryOptions?: [QueryOptions](../private.type.QueryOptions/README.md)): Promise\ #### ⚙ forPreparedVoid\(sql: [SqlSource](../type.SqlSource/README.md), callback: (prepared: [Resultsets](../class.Resultsets/README.md)\<`void`>) => Promise\, queryOptions?: [QueryOptionsVoid](../private.type.QueryOptionsVoid/README.md)): Promise\ #### ⚙ startTrx(options?: \{readonly?: `boolean`, xaId?: `string`, xaId1?: `string`}): Promise\<`void`> > Commit current transaction (if any), and start new. > This is lazy operation. The corresponding command will be sent to the server later (however commit of the current transaction will happen immediately). > To start regular transaction, call `startTrx()` without parameters. > To start READONLY transaction, pass `{readonly: true}`. > To start distributed transaction, pass `{xaId: '...'}`. > If you want `conn.connectionId` to be automatically appended to XA identifier, pass `{xaId1: '...'}`, where `xaId1` is the first part of the `xaId`. > If connection to server was not yet established, the `conn.connectionId` is not known (and `startTrx()` will not connect), so `conn.connectionId` will be appended later on first query. #### ⚙ savepoint(): `number` > Creates transaction savepoint, and returns ID number of this new savepoint. > Then you can call [conn.rollback(pointId)](../class.MyConn/README.md#-rollbacktopointid-number-promisevoid). > This is lazy operation. The corresponding command will be sent to the server later. > Calling `savepoint()` immediately followed by `rollback(pointId)` to this point will send no commands. #### ⚙ prepareCommit(): Promise\<`void`> > If the current transaction is of distributed type, this function prepares the 2-phase commit. > Else does nothing. > If this function succeeds, the transaction will be saved on the server till you call `commit()`. > The saved transaction can survive server restart and unexpected halt. > You need to commit it as soon as possible, to release all the locks that it holds. > Usually, you want to prepare transactions on all servers, and immediately commit them if `prepareCommit()` succeeded, or rollback them if it failed. #### ⚙ rollback(toPointId?: `number`): Promise\<`void`> > Rollback to a savepoint, or all. > If `toPointId` is not given or undefined - rolls back the whole transaction (XA transactions can be rolled back before `prepareCommit()` called, or after that). > If `toPointId` is a number returned from `savepoint()` call, rolls back to that point (also works with XAs). > If `toPointId` is `0`, rolls back to the beginning of transaction, and doesn't end this transaction (doesn't work with XAs). > If rollback (not to savepoint) failed, will disconnect from server and throw ServerDisconnectedError. > If `toPointId` was `0` (not for XAs), the transaction will be restarted after the disconnect if rollback failed. #### ⚙ commit(andChain: `boolean`=false): Promise\<`void`> > Commit. > If the current transaction is XA, and you didn't call `prepareCommit()` i'll throw error. > With `andChain` parameter will commit and then restart the same transaction (doesn't work with XAs). > If commit fails will rollback and throw error. If rollback also fails, will disconnect from server and throw ServerDisconnectedError. #### ⚙ setSqlLogger(sqlLogger?: [SqlLogger](../interface.SqlLogger/README.md) | `true`): `void` #### 📄 `protected` pendingTrxSql: `string`\[]
#### ⚙ `deprecated` execute(sql: [SqlSource](../type.SqlSource/README.md), params?: [Params](../type.Params/README.md), queryOptions?: [QueryOptionsVoid](../private.type.QueryOptionsVoid/README.md)): Promise\<[Resultsets](../class.Resultsets/README.md)\<`void`>> > Alias of queryVoid(). #### ⚙ `deprecated` makeLastColumnReader\(sql: [SqlSource](../type.SqlSource/README.md), params?: [Params](../type.Params/README.md), queryOptions?: [QueryOptions](../private.type.QueryOptions/README.md)): Promise\<`any`> > Stream column contents as `Deno.Reader`. If the resultset contains multiple columns, only the last one will be used (and others discarded). > > `deprecated` > > As `Deno.Reader` is deprecated, this method is deprecated as well. #### ⚙ `deprecated` forQuery\(sql: [SqlSource](../type.SqlSource/README.md), callback: (prepared: [Resultsets](../class.Resultsets/README.md)\>) => Promise\): Promise\ > Deprecated alias of `forPrepared()`. #### ⚙ `deprecated` forQueryMap\(sql: [SqlSource](../type.SqlSource/README.md), callback: (prepared: [Resultsets](../class.Resultsets/README.md)\>) => Promise\): Promise\ > Deprecated alias of `forPreparedMap()`. #### ⚙ `deprecated` forQueryArr\(sql: [SqlSource](../type.SqlSource/README.md), callback: (prepared: [Resultsets](../class.Resultsets/README.md)\) => Promise\): Promise\ > Deprecated alias of `forPreparedArr()`. #### ⚙ `deprecated` forQueryCol\(sql: [SqlSource](../type.SqlSource/README.md), callback: (prepared: [Resultsets](../class.Resultsets/README.md)\) => Promise\): Promise\ > Deprecated alias of `forPreparedCol()`. #### ⚙ `deprecated` forQueryVoid\(sql: [SqlSource](../type.SqlSource/README.md), callback: (prepared: [Resultsets](../class.Resultsets/README.md)\<`void`>) => Promise\): Promise\ > Deprecated alias of `forPreparedVoid()`.