Skip to main content

Database connection configuration manager

Project description

# db-facts

db-facts translates from user-familiar database coordinates (e.g., “redshift”, “corppostgres dbadmin”, “productoracle impl juser”) into detailed instructions on how to access the database in question, providing configuration and templating mechnisms to wrap any credential management tools involved in providing those details and credentials.

Example:

`sh $ db-facts sh redshift export CONNECTION_TYPE CONNECTION_TYPE=direct export LASTPASS_SHARE_NAME_SUFFIX LASTPASS_SHARE_NAME_SUFFIX='blue labs redshift' export DB_PASSWORD DB_PASSWORD='hunter2' DB_HOST=whatevs.whatevs.us-east-1.redshift.amazonaws.com export DB_HOST export DB_DATABASE DB_DATABASE=analytics export DB_USERNAME DB_USERNAME=vbroz export DB_PORT DB_PORT=5439 export DB_TYPE DB_TYPE=redshift export DB_PROTOCOL DB_PROTOCOL=postgres `

To do this, it relies on a config file (“dbcli.yml”) which teaches it how to parse the user-friendly coordinates. Much of the heavy lifting in the parsing part is done by [jinja_context.py](https://github.com/bluelabsio/db-facts/blob/master/db_facts/jinja_context.py), which sets some variables and functions that can be used in jinja templates within the config file.

This is part of the suite of programs which allow a user to type in things like db redshift and connect via their own credentials to the configured database named ‘redshift’. Other parts of this chain can be found in the [ws-scripts](https://github.com/bluelabsio/ws-scripts) repo.

If you need to set the instructions immediately to your environment variables, you can do this with the command: `sh eval $(db-facts redshift) `

## Configuration

You can configure db-facts to connect to your databases. See [CONFIGURATION.md](./CONFIGURATION.md) for details.

## Extensions

You can extend db-facts to pull configuration from other systems. See [EXTENSIONS.md](./EXTENSIONS.md) for details.

## Library

To use as a library:

`sh $ python Python 3.5.2 (default, Sep 12 2016, 09:31:17) [GCC 4.2.1 Compatible Apple LLVM 7.3.0 (clang-703.0.31)] on darwin Type "help", "copyright", "credits" or "license" for more information. >>> import bluelabs_db_facts >>> db_facts.db(['redshift']) {'protocol': 'postgres', 'lastpass_share_name_suffix': 'blue labs redshift', 'host': 'bl-int-analytics1.cxtyzogmmhiv.us-east-1.redshift.amazonaws.com', 'connection_type': 'direct', 'user': 'vbroz', 'database': 'analytics', 'password': 'hunter1', 'port': 5439, 'type': 'redshift'} >>> `

## Development

See [DEVELOPMENT.md](./DEVELOPMENT.md)

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

db_facts-3.0.1.tar.gz (16.2 kB view details)

Uploaded Source

Built Distribution

db_facts-3.0.1-py3-none-any.whl (27.9 kB view details)

Uploaded Python 3

File details

Details for the file db_facts-3.0.1.tar.gz.

File metadata

  • Download URL: db_facts-3.0.1.tar.gz
  • Upload date:
  • Size: 16.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.6.10

File hashes

Hashes for db_facts-3.0.1.tar.gz
Algorithm Hash digest
SHA256 4c5056be22cf3c895da9f50a85517d4391380cac74a4879f550478c84e0e9108
MD5 e8c4b3743ab69bdd29ebf0f87a8e0903
BLAKE2b-256 e2fb9a361f190e2795e28e27e04815cce863d188301e800250bd2dce08033dec

See more details on using hashes here.

File details

Details for the file db_facts-3.0.1-py3-none-any.whl.

File metadata

  • Download URL: db_facts-3.0.1-py3-none-any.whl
  • Upload date:
  • Size: 27.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.6.10

File hashes

Hashes for db_facts-3.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2f1afb0c34bf6dbe6134a05f2aaad6ea6cd229f92826238e87035621d9113bff
MD5 a53b6d92f30dd373a0b052fc60e50378
BLAKE2b-256 e9c9c860456686c37a9a76572fd584f94a474efc9e44a4b1f4440e2a45573f1a

See more details on using hashes here.

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