Skip to main content

Datalake Catalog

Project description

Setup and start the API

Configure the parameters with a python file

For example, catalog.conf.py

SECRET_KEY = b"changemenow"
DB_STRING = "sqlite://localhost/catalog.sqlite"

Start the catalog

docker run -d \
    -p '8080:8080' \
    -v 'catalog.conf.py:/etc/datacatalog/catalog.conf.py' \
    -e 'CATALOG_SETTINGS=/etc/datacatalog/catalog.conf.py' \
    public.ecr.aws/equancy-tech/datalake-catalog

Generate an API token

The catalog create-api-key generated tokens that can be used with restricted endpoint.

  • admin role can access all restricted endpoints
  • author role can only access the restricted endpoints in /catalog
Usage: catalog create-api-key [OPTIONS] NAME

Options:
  -e, --expires INTEGER      number of days before token expires
  -r, --role [author|admin]  the role associated with the name
  --help                     Show this message and exit.

Update the storages configuration

Storage configures aliases to help resolve actual buckets (S3, Azure, local fs, etc.). It consists of a bucket name and an optional prefix.

For example:

{
    "landing": {
        "bucket": "my-raw-bucket",
        "prefix": "landing"
    },
    "archive": {
        "bucket": "my-raw-bucket",
        "prefix": "archives"
    },
    "bronze": {
        "bucket": "my-bucket-bronze"
    },
    "silver": {
        "bucket": "my-bucket-silver"
    },
    "gold": {
        "bucket": "my-bucket-gold",
    }
}
curl -XPUT http://localhost:8080/storage \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer ${CATALOG_ADMIN_TOKEN}" \
    --data "@${STORAGE_CONFIG_FILE}" 

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

datalake-catalog-1.0.4.tar.gz (9.6 kB view hashes)

Uploaded Source

Built Distribution

datalake_catalog-1.0.4-py3-none-any.whl (11.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page