Skip to content

docs: update the step by step guide of connecting to a query engine - #1201

Merged
czgu merged 3 commits into
pinterest:masterfrom
jczhong84:docs/engine
Mar 22, 2023
Merged

czgu merged 3 commits into
pinterest:masterfrom
jczhong84:docs/engine

Conversation

@jczhong84

@jczhong84 jczhong84 commented Mar 20, 2023 •

Copy link
Copy Markdown
Collaborator

also

  • fixes a build error from the helm deployment doc update.
  • add package psycopg2, as it is needed by PostgreSQL.

@jczhong84
jczhong84 requested a review from czgu March 20, 2023 23:35

![](/img/documentation/Querybook_concepts.png)

- A query engine can be associated with a metastore.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A metastore can associate with one or more query engines?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread docs_website/docs/setup_guide/connect_to_a_query_engine.md Outdated
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

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this caution is the callout type.

@jczhong84
jczhong84 requested a review from czgu March 22, 2023 04:24
@czgu
czgu merged commit 5ee43b0 into pinterest:master Mar 22, 2023
@jczhong84
jczhong84 deleted the docs/engine branch April 7, 2023 00:40
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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants