SqlSink Class

A copy activity SQL sink.

All required parameters must be populated in order to send to Azure.

Constructor

SqlSink(*, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, write_batch_size: MutableMapping[str, Any] | None = None, write_batch_timeout: MutableMapping[str, Any] | None = None, sink_retry_count: MutableMapping[str, Any] | None = None, sink_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str, Any] | None = None, sql_writer_stored_procedure_name: MutableMapping[str, Any] | None = None, sql_writer_table_type: MutableMapping[str, Any] | None = None, pre_copy_script: MutableMapping[str, Any] | None = None, stored_procedure_parameters: MutableMapping[str, Any] | None = None, stored_procedure_table_type_parameter_name: MutableMapping[str, Any] | None = None, table_option: MutableMapping[str, Any] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
additional_properties	dict[str, <xref:JSON>] Unmatched properties from the message are deserialized to this collection. Default value: None
write_batch_size	<xref:JSON> Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. Default value: None
write_batch_timeout	<xref:JSON> Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])). Default value: None
sink_retry_count	<xref:JSON> Sink retry count. Type: integer (or Expression with resultType integer). Default value: None
sink_retry_wait	<xref:JSON> Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])). Default value: None
max_concurrent_connections	<xref:JSON> The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). Default value: None
sql_writer_stored_procedure_name	<xref:JSON> SQL writer stored procedure name. Type: string (or Expression with resultType string). Default value: None
sql_writer_table_type	<xref:JSON> SQL writer table type. Type: string (or Expression with resultType string). Default value: None
pre_copy_script	<xref:JSON> SQL pre-copy script. Type: string (or Expression with resultType string). Default value: None
stored_procedure_parameters	<xref:JSON> SQL stored procedure parameters. Default value: None
stored_procedure_table_type_parameter_name	<xref:JSON> The stored procedure parameter name of the table type. Type: string (or Expression with resultType string). Default value: None
table_option	<xref:JSON> The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string). Default value: None

Variables

Name	Description
additional_properties	dict[str, <xref:JSON>] Unmatched properties from the message are deserialized to this collection.
type	str Copy sink type. Required.
write_batch_size	<xref:JSON> Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
write_batch_timeout	<xref:JSON> Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).
sink_retry_count	<xref:JSON> Sink retry count. Type: integer (or Expression with resultType integer).
sink_retry_wait	<xref:JSON> Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).
max_concurrent_connections	<xref:JSON> The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
sql_writer_stored_procedure_name	<xref:JSON> SQL writer stored procedure name. Type: string (or Expression with resultType string).
sql_writer_table_type	<xref:JSON> SQL writer table type. Type: string (or Expression with resultType string).
pre_copy_script	<xref:JSON> SQL pre-copy script. Type: string (or Expression with resultType string).
stored_procedure_parameters	<xref:JSON> SQL stored procedure parameters.
stored_procedure_table_type_parameter_name	<xref:JSON> The stored procedure parameter name of the table type. Type: string (or Expression with resultType string).
table_option	<xref:JSON> The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string).

Methods

as_dict	Return a dict that can be serialized using json.dump. Advanced usage might optionally use a callback as parameter: Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object. The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict. See the three examples in this file: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer If you want XML serialization, you can pass the kwargs is_xml=True.
deserialize	Parse a str using the RestAPI syntax and return a model.
enable_additional_properties_sending
from_dict	Parse a dict using given key extractor return a model. By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Return the JSON that would be sent to azure from this model. This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False). If you want XML serialization, you can pass the kwargs is_xml=True.

as_dict

Return a dict that can be serialized using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

as_dict(keep_readonly: bool = True, key_transformer: ~typing.Callable[[str, ~typing.Dict[str, ~typing.Any], ~typing.Any], ~typing.Any] = <function attribute_transformer>, **kwargs: ~typing.Any) -> MutableMapping[str, Any]

Parameters

Name	Description
key_transformer	<xref:function> A key transformer function.
keep_readonly	Default value: True

Returns

Type	Description
dict	A dict JSON compatible object

deserialize

Parse a str using the RestAPI syntax and return a model.

deserialize(data: Any, content_type: str | None = None) -> ModelType

Parameters

Name	Description
data Required	str A str using RestAPI structure. JSON by default.
content_type	str JSON by default, set application/xml if XML. Default value: None

Returns

Type	Description
	An instance of this model

Exceptions

Type	Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

from_dict(data: Any, key_extractors: Callable[[str, Dict[str, Any], Any], Any] | None = None, content_type: str | None = None) -> ModelType

Parameters

Name	Description
data Required	dict A dict using RestAPI structure
content_type	str JSON by default, set application/xml if XML. Default value: None
key_extractors	Default value: None

Returns

Type	Description
	An instance of this model

Exceptions

Type	Description
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]

Parameters

Name	Description
keep_readonly	bool If you want to serialize the readonly attributes Default value: False

Returns

Type	Description
dict	A dict JSON compatible object