Skip to main content
Version: 12 - TBD

ConnectorTypeSQLMSSQL

class connector_types.connector_type_sqlmssql.ConnectorTypeSQLMSSQL(execution, workspace, inputs, cancel_event)

Base class: SqlLiveOutputMixin

Parameters

NameTypeDescription
cancel_eventEvent
executiondict
inputsdict
workspace

Input Schema

  • schema_version = '10.0'

    Type: string

  • authentication

    Type: anyOf

  • host

    The remote hostname or IP address.

    Type: string

  • port

    Type: anyOf

  • instance

    If set, the SQL Server Browser on port 1434 will be contacted to query

    the TCP port of the named instance. The port returned by the SQL Server Browser will

    take precedence to the one specified in the connection inputs.

    Type: string

  • database

    Type: string

  • dsn_additional_parameters

    Optional additional ODBC connection string parameters appended to the generated DSN.

    Example: {"Encrypt": "yes", "TrustServerCertificate": "no", "ApplicationIntent": "ReadOnly"}

    Type: object

    Additional Properties: {'element': 'form-string', 'type': 'string', 'default': '', 'label': 'Parameter value'}

  • mode

    Type: anyOf

  • isolation_level

    The transaction isolation level.

    Type: anyOf

    Default: READ_COMMITTED

  • autocommit

    If set to False transactions are enabled. Certain operations (e.g. CREATE DATABASE) require autocommit=True.

    Type: boolean

  • fast_executemany

    If set to True the executemany method will use the fast_executemany flag. This is faster but might use subtly different datatype conversion.

    Type: boolean

  • connect_timeout

    A timeout for connecting to a peer in seconds.

    Type: integer

    Default: 30

  • total_timeout

    Total timeout for the request in seconds.

    Type: integer

    Default: 30

  • live_output

    Stream partial output_value updates while the connection is running.

    Type: boolean

    Default: True

  • live_output_fetch_batch_size

    Number of rows per output_value update during fetch.

    Type: integer

    Default: 100

  • live_output_max_bytes

    Stop streaming fetch results to output_value once the serialized result exceeds this size in bytes. Set to 0 for no limit. The final output_value still contains all rows.

    Type: integer

    Default: 1048576

Output Schema