Skip to main content

packagesBeta

💡Did you know...
Available from dbt v1.12 or with the dbt "Latest" release track.
functions/<filename>.yml
functions:
  - name: <function name>
    config:
      packages: [<string>] # optional, Python UDFs only

Definition​

When creating Python UDFs, you can use the optional packages config to specify public third-party PyPI packages. You can list package names (for example, numpy and pandas) and pin versions (for example, pandas==1.5.0). The warehouse installs these packages when it creates the UDF, so your UDF can use functionality from external Python libraries.

On Snowflake, some packages are installed from the Anaconda repository, and you may need to accept Anaconda's Terms of Service before you can use them.

Python UDFs are currently supported in Snowflake and BigQuery. Each warehouse uses a different mechanism to specify packages. For example:

functions/schema.yml
functions:
  - name: is_positive_int
    description: Returns 1 if a_string matches ^[0-9]+$, else 0
    config:
      runtime_version: "3.11"
      entry_point: main
      packages:
        - numpy
        - pandas==1.5.0
    arguments:
      - name: a_string
        data_type: string
    returns:
      data_type: integer

Compiled SQL:

CREATE OR REPLACE FUNCTION my_schema.is_positive_int(a_string STRING)
  RETURNS INTEGER
  LANGUAGE PYTHON
  RUNTIME_VERSION = '3.11'
  HANDLER = 'main'
  PACKAGES = ('numpy','pandas==1.5.0')
AS $$
def main(a_string):
    ...
$$

Was this page helpful?

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.

0
Loading