Module datasae.converter.sql

sql library.

Classes

class Sql (name: str, file_path: str, drivername: str, username: str, password: str, host: str, port: int, database: str)

Represents a data source that connects to a sql table.

Args

drivername : str

The name of the database backend.

username : str

The username of sql connection.

password : str

The password of sql connection.

host : str

The host of sql connection.

port : int

The port of sql connection.

database : str

The database name of sql connection.

Expand source code

class Sql(DataSource):
    """
    Represents a data source that connects to a sql table.

    Args:
        drivername (str): The name of the database backend.
        username (str): The username of sql connection.
        password (str): The password of sql connection.
        host (str): The host of sql connection.
        port (int): The port of sql connection.
        database (str): The database name of sql connection.
    """

    drivername: str
    username: str
    password: str
    host: str
    port: int
    database: str

    @property
    def connection(self) -> Engine:
        """
        Returns an engine connection to the sql.

        Returns:
            sqlalchemy.Engine: An instance of the sqlalchemy class.
        """
        return create_engine(
            URL.create(**super().connection)
        )

    def __call__(self, query: str, *args, **kwargs) -> DataFrame:
        """
        __call__ method.

        Converts the data from the defined sql query into a
        Pandas DataFrame.

        Args:
            query (str): Sql query.
            *args: Additional positional arguments.
            **kwargs: Additional keyword arguments.

        Returns:
            DataFrame: A Pandas DataFrame.
        """
        if os.path.isfile(query):
            with open(query) as file:
                query = file.read()

        return super().__call__(FileType.SQL, query, *args, **kwargs)

Ancestors

• DataSource

Class variables

var database : str

var drivername : str

var host : str

var password : str

var port : int

var username : str

Instance variables

prop connection : Engine

Returns an engine connection to the sql.

Returns

sqlalchemy.Engine

An instance of the sqlalchemy class.

Expand source code

@property
def connection(self) -> Engine:
    """
    Returns an engine connection to the sql.

    Returns:
        sqlalchemy.Engine: An instance of the sqlalchemy class.
    """
    return create_engine(
        URL.create(**super().connection)
    )

Inherited members

• DataSource:
  • checker