:mod:`snowmobile.core.cfg.connection`
=====================================

.. py:module:: snowmobile.core.cfg.connection

.. autoapi-nested-parse::

   [connection] section from **snowmobile.toml**, including subsections.



Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   snowmobile.core.cfg.connection.Credentials
   snowmobile.core.cfg.connection.Connection



.. class:: Credentials

   Bases: :class:`snowmobile.core.cfg.base.Base`

   [connection.credentials.credentials_alias]

   .. attribute:: user
      :annotation: :str

      

   .. attribute:: password
      :annotation: :str

      

   .. attribute:: role
      :annotation: :str

      

   .. attribute:: account
      :annotation: :str

      

   .. attribute:: warehouse
      :annotation: :str

      

   .. attribute:: database
      :annotation: :str

      

   .. attribute:: schema_name
      :annotation: :str

      

   .. method:: as_nm(self, n: str)

      Sets the credentials alias.


   .. method:: credentials(self)
      :property:

      Returns namespace as a dictionary, excluding :attr:`_alias`.



.. class:: Connection(**data)


   Bases: :class:`snowmobile.core.cfg.base.Base`

   [connection]

   This includes the :attr:`default_alias` which is the set of credentials
   that :mod:`snowmobile` will authenticate with if :attr:`creds` is not
   explicitly passed.

   .. attribute:: default_alias

      The set of credentials that is used if :attr:`creds` is not
      explicitly passed to :class:`snowmobile.connect` on
      instantiation.

      :type: str

   .. attribute:: creds

      The name given to the set of credentials within the
      **credentials** block of the **snowmobile.toml** file (e.g.
      [credentials.creds] assigns an :attr:`creds` to a given set of
      credentials.

      :type: str

   .. attribute:: creds

      A dictionary of :attr:`creds` to the associated
      :class:`Creds` object containing its credentials.

      :type: dict[str, Creds]

   .. attribute:: default_alias
      :annotation: :str

      

   .. attribute:: provided_alias
      :annotation: :str

      

   .. attribute:: credentials
      :annotation: :Dict[str, Credentials]

      

   .. attribute:: defaults
      :annotation: :Dict

      

   .. method:: creds(self)
      :property:

      Credentials alias used by current Connection.


   .. method:: current(self)
      :property:

      Returns current credentials.


   .. method:: connect_kwargs(self) -> Dict
      :property:

      Arguments from snowmobile.toml for `snowflake.connector.connect()`.