:orphan:



.. _sphx_glr_auto_integrations_external_services_snowflake:

Snowflake
====

Flyte backend can be connected with snowflake service. Once enabled it can allow you to query a snowflake service.
This section will provide how to use the Snowflake Query Plugin using flytekit python.

Installation
------------

To use the flytekit snowflake plugin simply run the following:

.. prompt:: bash

    pip install flytekitplugins-snowflake

No Need of a dockerfile
------------------------
This plugin is purely a spec. Since SQL is completely portable there is no need to build a Docker container.


Configuring the backend to get snowflake working
---------------------------------------------
1. Make sure to add "snowflake" in ``tasks.task-plugins.enabled-plugin`` in `enabled_plugins.yaml <https://github.com/flyteorg/flyte/blob/master/deployment/sandbox/flyte_generated.yaml#L2296>`_

2. Add snowflake JWT token to Flytepropeller. `here <https://docs.snowflake.com/en/developer-guide/sql-api/guide.html#using-key-pair-authentication>`_ to see more detail to setup snowflake JWT token.

.. code-block:: bash

    kubectl edit secret -n flyte flyte-propeller-auth

Configuration will be like below

.. code-block:: bash

    apiVersion: v1
    data:
      FLYTE_SNOWFLAKE_CLIENT_TOKEN: <JWT_TOKEN>
      client_secret: Zm9vYmFy
    kind: Secret
    metadata:
      annotations:
        meta.helm.sh/release-name: flyte
        meta.helm.sh/release-namespace: flyte
    ...



.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to use a Flyte SnowflakeTask to execute a query.">

.. only:: html

 .. figure:: /auto/integrations/external_services/snowflake/images/thumb/sphx_glr_snowflake_thumb.png
     :alt: Snowflake Query

     :ref:`sphx_glr_auto_integrations_external_services_snowflake_snowflake.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto/integrations/external_services/snowflake/snowflake
.. raw:: html

    <div class="sphx-glr-clear"></div>



.. only :: html

 .. container:: sphx-glr-footer
    :class: sphx-glr-footer-gallery


  .. container:: sphx-glr-download sphx-glr-download-python

    :download:`Download all examples in Python source code: snowflake_python.zip </auto/integrations/external_services/snowflake/snowflake_python.zip>`



  .. container:: sphx-glr-download sphx-glr-download-jupyter

    :download:`Download all examples in Jupyter notebooks: snowflake_jupyter.zip </auto/integrations/external_services/snowflake/snowflake_jupyter.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_