SQLiteCloudConfig

Configuration for SQLite cloud connection

Table of contents

Properties

• clientId
• compression
• connectionString
• createDatabase
• database
• dbMemory
• gatewayUrl
• host
• insecure
• maxData
• maxRows
• maxRowset
• noBlob
• nonlinearizable
• password
• passwordHashed
• port
• timeout
• tlsOptions
• useWebsocket
• username
• verbose

Properties

clientId

• Optional clientId: string

Optional identifier used for verbose logging

Defined in

src/drivers/types.ts:62

compression

• Optional compression: boolean

Defined in

src/drivers/types.ts:41

connectionString

• Optional connectionString: string

Connection string in the form of sqlitecloud://user:password@host:port/database?options

Defined in

src/drivers/types.ts:15

createDatabase

• Optional createDatabase: boolean

Create the database if it doesn’t exist?

Defined in

src/drivers/types.ts:37

database

• Optional database: string

Name of database to open

Defined in

src/drivers/types.ts:34

dbMemory

• Optional dbMemory: boolean

Database will be created in memory

Defined in

src/drivers/types.ts:39

gatewayUrl

• Optional gatewayUrl: string

Url where we can connect to a SQLite Cloud Gateway that has a socket.io deamon waiting to connect, eg. wss://host:4000

Defined in

src/drivers/types.ts:59

host

• Optional host: string

Host name is required unless connectionString is provided, eg: xxx.sqlitecloud.io

Defined in

src/drivers/types.ts:25

insecure

• Optional insecure: boolean

Connect using plain TCP port, without TLS encryption, NOT RECOMMENDED, TEST ONLY

Defined in

src/drivers/types.ts:29

maxData

• Optional maxData: number

Do not send columns with more than max_data bytes

Defined in

src/drivers/types.ts:47

maxRows

• Optional maxRows: number

Server should chunk responses with more than maxRows

Defined in

src/drivers/types.ts:49

maxRowset

• Optional maxRowset: number

Server should limit total number of rows in a set to maxRowset

Defined in

src/drivers/types.ts:51

noBlob

• Optional noBlob: boolean

Server should send BLOB columns

Defined in

src/drivers/types.ts:45

nonlinearizable

• Optional nonlinearizable: boolean

Request for immediate responses from the server node without waiting for linerizability guarantees

Defined in

src/drivers/types.ts:43

password

• Optional password: string

Password is required unless connection string is provided

Defined in

src/drivers/types.ts:20

passwordHashed

• Optional passwordHashed: boolean

True if password is hashed, default is false

Defined in

src/drivers/types.ts:22

port

• Optional port: number

Port number for tls socket

Defined in

src/drivers/types.ts:27

timeout

• Optional timeout: number

Optional query timeout passed directly to TLS socket

Defined in

src/drivers/types.ts:32

tlsOptions

• Optional tlsOptions: ConnectionOptions

Custom options and configurations for tls socket, eg: additional certificates

Defined in

src/drivers/types.ts:54

useWebsocket

• Optional useWebsocket: boolean

True if we should force use of SQLite Cloud Gateway and websocket connections, default: true in browsers, false in node.js

Defined in

src/drivers/types.ts:57

username

• Optional username: string

User name is required unless connectionString is provided

Defined in

src/drivers/types.ts:18

verbose

• Optional verbose: boolean

True if connection should enable debug logs

Defined in

src/drivers/types.ts:64