Lua driver for Exasol

• Index

Contents

• Tables
• Methods

Classes

• luasql.exasol.Connection
• luasql.exasol.ConnectionProperties
• luasql.exasol.Cursor
• luasql.exasol.CursorData
• luasql.exasol.Environment
• luasql.exasol.ExasolWebsocket
• luasql.exasol.Websocket
• luasql.exasol.WebsocketDatahandler

Modules

• luasql.exasol
• luasql.exasol.constants
• luasql.exasol.util

Examples

• examples.lua

Class luasql.exasol.ConnectionProperties

This internal class represents configuration properties for a database connection.

Tables

luasql.exasol.connectionproperties.properties

Available properties for the luasql.exasol.ConnectionProperties:create method.

Methods

luasql.exasol.connectionproperties:create(properties)	Create a new instance of the Connection class.
luasql.exasol.connectionproperties:get_fetchsize_bytes()	Get the configured fetch size in bytes used when fetching query result data.
luasql.exasol.connectionproperties:get_tls_verify()	Get the configured TLS verify mode for connecting to Exasol.
luasql.exasol.connectionproperties:get_tls_protocol()	Get the configured TLS protocol for connecting to Exasol.
luasql.exasol.connectionproperties:get_tls_options()	Get the configured TLS options for connection to Exasol.
luasql.exasol.connectionproperties:get_fingerprint()	Get the normalized TLS certificate fingerprint, if configured.

Tables

luasql.exasol.connectionproperties.properties line 52

Available properties for the luasql.exasol.ConnectionProperties:create method.

Fields:

• fetchsize_kib The fetch size in KiB used when fetching query result data, see luasql.exasol.ConnectionProperties:get_fetchsize_bytes. Default value: 128.
• tls_verify

  The TLS verify mode for connecting to Exasol, see luasql.exasol.ConnectionProperties:get_tls_verify and LuaSec documentation. Default value: none, available values:

  • none
  • peer
  • client_once
  • fail_if_no_peer_cert
• tls_protocol The TLS protocol for connecting to Exasol, see luasql.exasol.ConnectionProperties:get_tls_protocol and LuaSec documentation. Default value: tlsv1_2, available values:
  • tlsv1
  • tlsv1_1
  • tlsv1_2 (default)
  • tlsv1_3

  Run the following command to find out which TLS version your Exasol server supports:

  openssl s_client -connect "<IP-Address>:<Port>" < /dev/null 2>/dev/null | grep Protocol

• tls_options The TLS options for connecting to Exasol, see luasql.exasol.ConnectionProperties:get_tls_options. The value is a comma-separated list of options without spaces, e.g. no_tlsv1,no_sslv2. Default value: all. See output of the following Lua code for a list of available values:

  require("ssl").config.options

• fingerprint Optional SHA-256 fingerprint used to pin the TLS peer certificate. The value is 64 hexadecimal digits. Upper-case hexadecimal input is accepted and normalized to lower case.

Methods

luasql.exasol.connectionproperties:create(properties) line 57

Create a new instance of the Connection class.

Parameters:

• properties optional table a properties object or nil to use default settings, see luasql.exasol.ConnectionProperties:properties for details

Returns:

luasql.exasol.Connection connection the new instance

Raises:

error if given properties are not valid

luasql.exasol.connectionproperties:get_fetchsize_bytes() line 88

Get the configured fetch size in bytes used when fetching query result data. Configuration property: fetchsize_kib, see luasql.exasol.ConnectionProperties:properties. Default value: 131072 = 128 * 1024.

Returns:

integer fetchsize in bytes

luasql.exasol.connectionproperties:get_tls_verify() line 95

Get the configured TLS verify mode for connecting to Exasol. Configuration property: tls_verify, see luasql.exasol.ConnectionProperties:properties.

Returns:

string TLS verify mode

luasql.exasol.connectionproperties:get_tls_protocol() line 102

Get the configured TLS protocol for connecting to Exasol. Configuration property: tls_protocol, see luasql.exasol.ConnectionProperties:properties.

Returns:

string TLS protocol

luasql.exasol.connectionproperties:get_tls_options() line 109

Get the configured TLS options for connection to Exasol. Configuration property: tls_options, see luasql.exasol.ConnectionProperties.properties.

Returns:

string TLS options

luasql.exasol.connectionproperties:get_fingerprint() line 116

Get the normalized TLS certificate fingerprint, if configured. Configuration property: fingerprint, see luasql.exasol.ConnectionProperties:properties.

Returns:

nil or string lower-case SHA-256 certificate fingerprint