Interface SQLiteCloudConfig

Configuration for SQLite cloud connection

Note

Options are all lowecase so they 1:1 compatible with C SDK

interface SQLiteCloudConfig {
    apikey?: string;
    clientid?: string;
    compression?: boolean;
    connectionstring?: string;
    create?: boolean;
    database?: string;
    gatewayurl?: string;
    host?: string;
    insecure?: boolean;
    maxdata?: number;
    maxrows?: number;
    maxrowset?: number;
    memory?: boolean;
    noblob?: boolean;
    non_linearizable?: boolean;
    password?: string;
    password_hashed?: boolean;
    port?: number;
    timeout?: number;
    tlsoptions?: ConnectionOptions;
    username?: string;
    usewebsocket?: boolean;
    verbose?: boolean;
    zerotext?: boolean;
}

Properties

apikey? clientid? compression? connectionstring? create? database? gatewayurl? host? insecure? maxdata? maxrows? maxrowset? memory? noblob? non_linearizable? password? password_hashed? port? timeout? tlsoptions? username? usewebsocket? verbose? zerotext?

Properties

Optionalapikey

apikey?: string

API key can be provided instead of username and password

Optionalclientid

clientid?: string

Optional identifier used for verbose logging

Optionalcompression

compression?: boolean

Optionalconnectionstring

connectionstring?: string

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

Optionalcreate

create?: boolean

Create the database if it doesn't exist?

Optionaldatabase

database?: string

Name of database to open

Optionalgatewayurl

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

Optionalhost

host?: string

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

Optionalinsecure

insecure?: boolean

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

Optionalmaxdata

maxdata?: number

Do not send columns with more than max_data bytes

Optionalmaxrows

maxrows?: number

Server should chunk responses with more than maxRows

Optionalmaxrowset

maxrowset?: number

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

Optionalmemory

memory?: boolean

Database will be created in memory

Optionalnoblob

noblob?: boolean

Server should send BLOB columns

Optionalnon_linearizable

non_linearizable?: boolean

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

Optionalpassword

password?: string

Password is required unless connection string is provided

Optionalpassword_hashed

password_hashed?: boolean

True if password is hashed, default is false

Optionalport

port?: number

Port number for tls socket

Optionaltimeout

timeout?: number

Optional query timeout passed directly to TLS socket

Optionaltlsoptions

tlsoptions?: ConnectionOptions

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

Optionalusername

username?: string

User name is required unless connectionstring is provided

Optionalusewebsocket

usewebsocket?: boolean

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

Optionalverbose

verbose?: boolean

True if connection should enable debug logs

Optionalzerotext

zerotext?: boolean

Flag to tell the server to zero-terminate strings

Settings

Member Visibility

On This Page

Properties