Function write

python/pathway/io/dynamodb/__init__.py:19–270

Writes ``table`` into a DynamoDB table. The connection settings are retrieved from the environment. This connector supports three modes: ``default`` mode, which performs no preparation on the target table; ``create_if_not_exists`` mode, which creates the table if it does not al

(
    table: Table,
    table_name: str,
    partition_key: ColumnReference,
    *,
    sort_key: ColumnReference | None = None,
    init_mode: Literal["default", "create_if_not_exists", "replace"] = "default",
    name: str | None = None,
)

@check_arg_types
@trace_user_frame
def write(
    table: Table,
    table_name: str,
    partition_key: ColumnReference,
    *,
    sort_key: ColumnReference | None = None,
    init_mode: Literal["default", "create_if_not_exists", "replace"] = "default",
    name: str | None = None,
) -> None:
    """
    Writes ``table`` into a DynamoDB table. The connection settings are retrieved from
    the environment.

    This connector supports three modes: ``default`` mode, which performs no preparation
    on the target table; ``create_if_not_exists`` mode, which creates the table if it does
    not already exist; and ``replace`` mode, which replaces the table and clears any
    previously existing data. The table is created with an
    `on-demand <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/capacity-mode.html>`_
    billing mode. Be aware that this mode may not be optimal for your use case, and the
    provisioned mode with capacity planning might offer better performance or cost
    efficiency. In such cases, we recommend creating the table yourself in AWS with the
    desired provisioned throughput settings.

    Note that if the table already exists and you use either ``default`` or
    ``create_if_not_exists`` mode, the schema of the table, including the primary key and
    optional sort key, must match the schema of the table you are writing.

    The connector performs writes using the primary key, defined as a combination of the
    partition key and an optional sort key. Note that, due to how DynamoDB operates,
    entries may overwrite existing ones if their keys coincide. When an entry is deleted
    from the Pathway Live Data Framework table, the corresponding entry is also removed from the DynamoDB
    table maintained by the connector. In this sense, the connector behaves similarly to
    the snapshot mode in the
    `Delta Lake </developers/api-docs/pathway-io/deltalake/#pathway.io.deltalake.write>`_
    output connector or the
    `Postgres </developers/api-docs/pathway-io/postgres#pathway.io.postgres.write_snapshot>`_
    output connector.

    Args:
        table: The table to write.
        table_name: The name of the destination table in DynamoDB.
        partition_key: The column to use as the
            `partition key <https://aws.amazon.com/blogs/database/choosing-the-right-dynamodb-partition-key/>`_
            in the destination table. Note that only the scalar types ``String``, ``Number``
            and ``Binary`` can be used as index fields in DynamoDB. Therefore, the field you
            select in the Pathway Live Data Framework table must serialize to one of these types. You can verify
            this using the conversion table provided in the connector documentation. In
            particular, ``bool`` columns serialize to the DynamoDB ``Boolean`` type, which is
            not a valid key type, so they cannot be used as a partition or sort key.
        sort_key: An optional sort key for the destination table. Note that only the scalar
            types ``String``, ``Number`` and ``Binary`` can be used as the index fields in
            DynamoDB. Similarly to the partition key, you can only use fields that serialize
            into one of these scalar DynamoDB types.
        init_mode: The table initialization mode, one of the three described above.
        name: A unique name for the connector. If provided, this name will be used in
            logs and monitoring dashboards.

    Returns: