Function write

python/pathway/io/mssql/__init__.py:276–484

Writes ``table`` to a Microsoft SQL Server table. The connector works in two modes: **snapshot** mode and **stream of changes**. In **snapshot** mode, the table maintains the current snapshot of the data using MSSQL's ``MERGE`` statement for atomic upserts. In **stream of changes**

(
    table: Table,
    connection_string: str,
    table_name: str,
    *,
    schema_name: str = "dbo",
    max_batch_size: int | None = None,
    init_mode: Literal["default", "create_if_not_exists", "replace"] = "default",
    output_table_type: Literal["stream_of_changes", "snapshot"] = "stream_of_changes",
    primary_key: list[ColumnReference] | None = None,
    name: str | None = None,
    sort_by: Iterable[ColumnReference] | None = None,
)

@check_arg_types
@trace_user_frame
def write(
    table: Table,
    connection_string: str,
    table_name: str,
    *,
    schema_name: str = "dbo",
    max_batch_size: int | None = None,
    init_mode: Literal["default", "create_if_not_exists", "replace"] = "default",
    output_table_type: Literal["stream_of_changes", "snapshot"] = "stream_of_changes",
    primary_key: list[ColumnReference] | None = None,
    name: str | None = None,
    sort_by: Iterable[ColumnReference] | None = None,
) -> None:
    """Writes ``table`` to a Microsoft SQL Server table.

    The connector works in two modes: **snapshot** mode and **stream of changes**.
    In **snapshot** mode, the table maintains the current snapshot of the data
    using MSSQL's ``MERGE`` statement for atomic upserts.
    In **stream of changes** mode, the table contains the log of all data updates
    with ``time`` and ``diff`` columns.

    Compatible with all MSSQL versions on Linux (SQL Server 2017, 2019, 2022,
    and Azure SQL Edge). Uses pure Rust TDS implementation — no ODBC drivers required.

    Args:
        table: Table to be written.
        connection_string: ADO.NET-style connection string for the MSSQL database.
            Example: ``"Server=tcp:localhost,1433;Database=mydb;User Id=sa;Password=pass;TrustServerCertificate=true"``
        table_name: Name of the target table.
        schema_name: Name of the database schema containing the table. Defaults to
            ``"dbo"``, which is the default schema in MSSQL.
        max_batch_size: Maximum number of entries allowed to be committed within a
            single transaction.
        init_mode: ``"default"``: The default initialization mode;
            ``"create_if_not_exists"``: creates the table if it does not exist;
            ``"replace"``: drops and recreates the table.
        output_table_type: Defines how the output table manages its data. If set to
            ``"stream_of_changes"`` (the default), the system outputs a stream of
            modifications with ``time`` and ``diff`` columns. If set to ``"snapshot"``,
            the table maintains the current state using atomic MERGE upserts.
        primary_key: When using snapshot mode, one or more columns that form the primary
            key in the target MSSQL table.
        name: A unique name for the connector. If provided, this name will be used in
            logs and monitoring dashboards.
        sort_by: If specified, the output will be sorted in ascending order based on the
            values of the given columns within each minibatch. When multiple columns are provided,
            the corresponding value tuples will be compared lexicographically.

    Returns:
        None

    Example:

    To test this connector locally, run a MSSQL instance using Docker:

    .. code-block:: bash

        docker run -e 'ACCEPT_EULA=Y' -e 'MSSQL_SA_PASSWORD=YourStrong!Passw0rd' \\