cxKysely

Auto-generated documentation from JSDoc comments

Classes

• ConnexCSDriver
  • new ConnexCSDriver(config)
  • .init() ⇒ Promise.<void>
  • .acquireConnection() ⇒ Promise.<ConnexCSConnection>
  • .beginTransaction(conn) ⇒ Promise.<void>
  • .commitTransaction(conn) ⇒ Promise.<void>
  • .rollbackTransaction(conn) ⇒ Promise.<void>
  • .releaseConnection(_conn) ⇒ Promise.<void>
  • .destroy() ⇒ Promise.<void>
• ConnexCSConnection
  • new ConnexCSConnection(config)
  • .executeQuery(compiledQuery) ⇒ Promise.<object>
  • .beginTransaction()
  • .commitTransaction()
  • .rollbackTransaction()
  • .streamQuery(_compiledQuery, _chunkSize)

Objects

• cxKysely : object
  • .ConnexCSDialect
    • new ConnexCSDialect()

ConnexCSDriver

Kind: global class

• ConnexCSDriver
  • new ConnexCSDriver(config)
  • .init() ⇒ Promise.<void>
  • .acquireConnection() ⇒ Promise.<ConnexCSConnection>
  • .beginTransaction(conn) ⇒ Promise.<void>
  • .commitTransaction(conn) ⇒ Promise.<void>
  • .rollbackTransaction(conn) ⇒ Promise.<void>
  • .releaseConnection(_conn) ⇒ Promise.<void>
  • .destroy() ⇒ Promise.<void>

new ConnexCSDriver(config)

Creates a new ConnexCSDriver instance

Param	Type	Description
config	object	Driver configuration

connexCSDriver.init() ⇒ Promise.<void>

Initialize the driver

Kind: instance method of ConnexCSDriver

connexCSDriver.acquireConnection() ⇒ Promise.<ConnexCSConnection>

Acquire a database connection

Kind: instance method of ConnexCSDriver
Returns: Promise.<ConnexCSConnection> - A new connection instance

connexCSDriver.beginTransaction(conn) ⇒ Promise.<void>

Begin a database transaction

Kind: instance method of ConnexCSDriver

Param	Type	Description
conn	ConnexCSConnection	The connection to use

connexCSDriver.commitTransaction(conn) ⇒ Promise.<void>

Commit a database transaction

Kind: instance method of ConnexCSDriver

Param	Type	Description
conn	ConnexCSConnection	The connection to use

connexCSDriver.rollbackTransaction(conn) ⇒ Promise.<void>

Rollback a database transaction

Kind: instance method of ConnexCSDriver

Param	Type	Description
conn	ConnexCSConnection	The connection to use

connexCSDriver.releaseConnection(_conn) ⇒ Promise.<void>

Release a database connection back to the pool

Kind: instance method of ConnexCSDriver

Param	Type	Description
_conn	ConnexCSConnection	The connection to release

connexCSDriver.destroy() ⇒ Promise.<void>

Destroy the driver and clean up resources

Kind: instance method of ConnexCSDriver

ConnexCSConnection

Kind: global class

• ConnexCSConnection
  • new ConnexCSConnection(config)
  • .executeQuery(compiledQuery) ⇒ Promise.<object>
  • .beginTransaction()
  • .commitTransaction()
  • .rollbackTransaction()
  • .streamQuery(_compiledQuery, _chunkSize)

new ConnexCSConnection(config)

Creates a new ConnexCSConnection instance

Param	Type	Description
config	object	Connection configuration

connexCSConnection.executeQuery(compiledQuery) ⇒ Promise.<object>

Execute a compiled SQL query

Kind: instance method of ConnexCSConnection
Returns: Promise.<object> - Query results with insertId, rows, and numAffectedRows
Throws:

• Error If the query execution fails

Param	Type	Description
compiledQuery	object	The compiled query object from Kysely
compiledQuery.sql	string	The SQL string to execute
compiledQuery.parameters	Array	Query parameters

connexCSConnection.beginTransaction()

Begin a database transaction

Kind: instance method of ConnexCSConnection
Throws:

• Error Transactions are not supported

connexCSConnection.commitTransaction()

Commit a database transaction

Kind: instance method of ConnexCSConnection
Throws:

• Error Transactions are not supported

connexCSConnection.rollbackTransaction()

Rollback a database transaction

Kind: instance method of ConnexCSConnection
Throws:

• Error Transactions are not supported

connexCSConnection.streamQuery(_compiledQuery, _chunkSize)

Stream query results

Kind: instance method of ConnexCSConnection
Throws:

• Error Streaming is not supported

Param	Type	Description
_compiledQuery	object	The compiled query object
_chunkSize	number	Size of each chunk

cxKysely : object

Kysely Dialect for ConnexCS

Kind: global namespace

• cxKysely : object
  • .ConnexCSDialect
    • new ConnexCSDialect()

cxKysely.ConnexCSDialect

Implements the Kysely Dialect interface for ConnexCS database connections

Kind: static class of cxKysely

new ConnexCSDialect()

ConnexCS Dialect for Kysely