docs: update the step by step guide of connecting to a query engine #1201
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
czgu
reviewed
Mar 22, 2023
| @@ -44,6 +44,12 @@ Once a metastore is created, you can configure the auto sync schedule, manually | |||
|
|
|||
| Query engine configures the endpoints that users can query. Each query engine needs to be attached to an environment for security measures. They can also attach a metastore to allow users to see table information while writing queries. All available query engine executors are grouped by language and each of them have different configuration values that needs to be set. | |||
|
|
|||
|  | |||
|
|
|||
| - A query engine can be associated with a metastore. | |||
There was a problem hiding this comment.
A metastore can associate with one or more query engines?
There was a problem hiding this comment.
I'm trying to phrase this from the query engine's point of view, as the association happens on creating the query engine, not on the metastore view.
| postgresql://<username>:<password>@<server-host>:<port>/<database> | ||
| ``` | ||
| Please refer to the SqlAlchemy [documentation](https://docs.sqlalchemy.org/en/20/core/engines.html#postgresql) for the connection string format. | ||
| - Select `ConnectionChecker` as status checker |
There was a problem hiding this comment.
select 1 check is better for postgres?
| Please refer to the SqlAlchemy [documentation](https://docs.sqlalchemy.org/en/20/core/engines.html#postgresql) for the connection string format. | ||
| - Select `ConnectionChecker` as status checker | ||
|
|
||
| :::caution About localhost |
There was a problem hiding this comment.
this caution is the callout type.
czgu
approved these changes
Mar 22, 2023
rohan-sh1
pushed a commit
to CAI-TECHNOLOGIES/cai-ext-db-explorer
that referenced
this pull request
Apr 11, 2023
…interest#1201) * docs: update the step by step guide of connecting to a query engine * link to general config * comments and add psycopg2
aidenprice
pushed a commit
to arrowtail-precision/querybook
that referenced
this pull request
Jan 3, 2024
…interest#1201) * docs: update the step by step guide of connecting to a query engine * link to general config * comments and add psycopg2
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.
also
psycopg2, as it is needed by PostgreSQL.