Add documentation for connecting to a database over ssh #2238
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for dlt-hub-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
AstrakhantsevaAA
requested changes
Feb 17, 2025
|
|
||
| # Close the SSH tunnel to release resources | ||
| tunnel.close() | ||
| ``` |
There was a problem hiding this comment.
this would be more pythonic:
ssh_creds = dlt.secrets["ssh"]
db_creds = dlt.secrets["destination.sqlalchemy.credentials"]
with SSHTunnelForwarder(
(ssh_creds["server_ip_address"], 22),
ssh_username=ssh_creds["username"],
ssh_pkey=ssh_creds["private_key_path"],
ssh_private_key_password=ssh_creds.get("private_key_password"),
remote_bind_address=("127.0.0.1", 5432),
) as tunnel:
engine = create_engine(
f"postgresql://{db_creds['username']}:{db_creds['password']}"
f"@127.0.0.1:{tunnel.local_bind_port}/{db_creds['database']}"
)
# Access database table as a dlt resource
table_resource = sql_table(engine, table="employees", schema="public")
# Define and run the pipeline
pipeline = dlt.pipeline(
pipeline_name="remote_db_pipeline",
destination="duckdb",
dataset_name="remote_dataset"
)
print(pipeline.run(table_resource))
There was a problem hiding this comment.
updated as per the above code
|
|
||
| #### Using SqlAlchemy Engine as credentials | ||
| ### Using SqlAlchemy Engine as credentials | ||
|
|
||
| You are able to pass an instance of SqlAlchemy Engine instead of credentials: |
There was a problem hiding this comment.
Suggested change
| You are able to pass an instance of SqlAlchemy Engine instead of credentials: | |
| You are able to pass an instance of SQLAlchemy Engine instead of credentials: |
| @@ -160,9 +160,9 @@ source = sql_database(credentials).with_resources("family") | |||
| It is recommended to configure credentials in `.dlt/secrets.toml` and to not include any sensitive information in the pipeline code. | |||
| ::: | |||
|
|
|||
| ### Other connection options | |||
| ## Other connection options | |||
There was a problem hiding this comment.
Suggested change
| ## Other connection options |
dat-a-man
force-pushed
the
docs/update-sql-documentation-connect-via-ssh
branch
from
8a46bac to
8d61c8a
Compare
dat-a-man
force-pushed
the
docs/update-sql-documentation-connect-via-ssh
branch
from
bbdd9f7 to
c04284c
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR updates the SQL database configuration documentation to explain how to connect to a database using an SSH tunnel. Key additions include:
These changes aim to help users securely access remote databases behind firewalls or requiring SSH.