Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

Connect to databases via ssh tunnel

Project description

A command tool and library to connect to databases with minimal fuss.

To install:

$ pip install tunneler

To run:

$ tunneler name_of_task name_of_connection

As the above command shows, there are two concepts to understand when running tunneler, connections and tasks.

Define connections in a connections.yaml file in your current directory, as follows:

  remote_host: publicjumpboxservername
  ssh_username: username
  ssh_pkey: |
    -----END RSA PRIVATE KEY-----
  private_dburl: postgres://username:password@privatedbservername/databasename
  local_port: 5433


Tunneler will use this information to set up a local tunneled post where you can access this database directly.

A connection URL to this local port will then be provided to each task.

There are three inbuilt tasks:

  • test_connection (run this one to check your config is correct)
  • do_full_pg_dump
  • do_schema_pg_dump

So for example to dump the production schema we’d run the following command:

$ tunneler do_schema_pg_dump prod

Custom tasks

Want to define your own tasks? Simply create a file (or module) in the current directory.

Define a top level method in this file that accepts a connection url, and that method name will be available as a task.

For instance, the test connection task could be re-implemented as follows:

from sqlbag import S

def test_connection_custom(dburl):
    with S(dburl) as s:
        s.execute('select 1')

You’d then run this as follows:

$ tunneler test_connection_custom prod

Pretty simple.

Project details

Download files

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

Files for tunneler, version 0.1.1490677240
Filename, size File type Python version Upload date Hashes
Filename, size tunneler-0.1.1490677240-py2.py3-none-any.whl (6.9 kB) File type Wheel Python version 3.6 Upload date Hashes View
Filename, size tunneler-0.1.1490677240.tar.gz (3.9 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page