Skip to content

Commit 989558c

Browse files
committed
add astro-registry config
1 parent f3bcc88 commit 989558c

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

.astro-registry.yaml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# This file is intended to be a file which specifically calls out modules to be published to the Astronomer
2+
# Registry as well as top-level Provider metadata. The file should not be packaged and solely lives in the
3+
# repo. The modules listed should pertain to latest, released version of the repo.
4+
5+
# Python package name.
6+
package-name: duckdb_provider
7+
# The name of the provider to be displayed on the Registry.
8+
display-name: DuckDB Provider
9+
# A description to be displayed on the main Provider page.
10+
description: An Airflow provider to interact with DuckDB
11+
# URL for where user should find the documentation for the Provider. This could be a link to the README,
12+
# an external docs site, etc.
13+
docs_url: https://github.com/astronomer/airflow-provider-duckdb
14+
15+
# The next sections should be organized by module type (e.g. operators, hooks, functions, decorators, etc.).
16+
#
17+
# Within each section, the ``module`` value should be the path.to.the.module.specifically.
18+
# For example, if the import path for a function is `from sample_provider.hooks.sample_hook import SampleHook` then the
19+
# value should be "sample_provider.hooks.sample_hook.SampleHook".
20+
21+
hooks:
22+
- module: duckdb_provider.hooks.duckdb_hook.DuckDBHook

README.md

+5
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ The connection type is `duckdb`. It supports setting the following parameters:
1414

1515
- `file` (optional): The path to the DuckDB database file. If not set, operations will be done in-memory.
1616

17+
Example connection strings:
18+
19+
- `duckdb://:memory:`
20+
- `duckdb:///tmp/duckdb.db`
21+
1722
## Usage
1823

1924
```python

0 commit comments

Comments
 (0)