Source code for airflow.providers.microsoft.mssql.hooks.mssql

#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

"""Microsoft SQLServer hook module"""

import pymssql

from airflow.providers.common.sql.hooks.sql import DbApiHook


[docs]class MsSqlHook(DbApiHook):
    """Interact with Microsoft SQL Server."""

[docs]    conn_name_attr = 'mssql_conn_id'
[docs]    default_conn_name = 'mssql_default'
[docs]    conn_type = 'mssql'
[docs]    hook_name = 'Microsoft SQL Server'
[docs]    supports_autocommit = True

    def __init__(self, *args, **kwargs) -> None:
        super().__init__(*args, **kwargs)
        self.schema = kwargs.pop("schema", None)

[docs]    def get_conn(
        self,
    ) -> pymssql.connect:
        """Returns a mssql connection object"""
        conn = self.get_connection(self.mssql_conn_id)  # type: ignore[attr-defined]

        conn = pymssql.connect(
            server=conn.host,
            user=conn.login,
            password=conn.password,
            database=self.schema or conn.schema,
            port=conn.port,
        )
        return conn

[docs]    def set_autocommit(
        self,
        conn: pymssql.connect,
        autocommit: bool,
    ) -> None:
        conn.autocommit(autocommit)

[docs]    def get_autocommit(self, conn: pymssql.connect):
        return conn.autocommit_state