Package Exports

@vulcan-sql/extension-driver-canner
@vulcan-sql/extension-driver-canner/src/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@vulcan-sql/extension-driver-canner) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

extension-driver-canner

Connect to canner enterprise through PostgreSQL Wire Protocol

Install

Install package

npm i @vulcan-sql/extension-driver-canner

Update vulcan.yaml, enable the extension.

extensions:
  canner: '@vulcan-sql/extension-driver-canner'

Create a new profile in profiles.yaml or in your profiles' paths.

- name: canner # profile name
  type: canner
  connection:
   
   
   # Optional: Server host.
   host: string
   # Optional: The user to connect to canner enterprise. Default canner
   user: string
   # Optional: Password to connect to canner enterprise. should be the user PAT in canner enterprise
   password: string
   # Optional: sql name of the workspace.
   database: string
   # Optional: canner enterprise PostgreSQL wire protocol port
   port: 7432
   # Optional: The max rows we should fetch once.
   chunkSize: 100
   # Optional: Maximum number of clients the pool should contain.
   max: 10
   # Optional: Number of milliseconds before a statement in query will time out, default is no timeout
   statement_timeout: 0
   # Optional: Passed directly to node.TLSSocket, supports all tls.connect options
   ssl: false
   # Optional: Number of milliseconds before a query call will timeout, default is no timeout
   query_timeout: 0
   # Optional: The name of the application that created this Client instance
   application_name: string
   # Optional: Number of milliseconds to wait for connection, default is no timeout
   connectionTimeoutMillis: 0
   # Optional: Number of milliseconds before terminating any session with an open idle transaction, default is no timeout
   idle_in_transaction_session_timeout: 0
   # Optional: Number of milliseconds a client must sit idle in the pool and not be checked out before it is disconnected from the backend and discarded.
   idleTimeoutMillis: 10000