-
Notifications
You must be signed in to change notification settings - Fork 4.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Destination-Postgres: updated postgres.md documentation as per BETA template #12279
Destination-Postgres: updated postgres.md documentation as per BETA template #12279
Conversation
…ed-to-beta # Conflicts: # docs/integrations/destinations/postgres.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added some minor changes to wording in comments
|
||
#### Requirements | ||
You should now have all the requirements needed to configure Postgres as a destination in the UI. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You should now have all the requirements needed to configure Postgres as a destination in the UI.
I think this sentence is redundant and should be removed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated, thanks!
* **Port** - The port number the server is listening on. Defaults to the PostgreSQL™ standard port number (5432). | ||
* **Username** | ||
* **Password** | ||
* **Default Schema Name** - Specify the schema (or several schema separated by commas) to be set in the search-path. This schema will be used to resolve unqualified object names used in statements over this connection. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit:
- several schemas
- These schemas will be used to resolve unqualified object names
usedin statements executed over this connection
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated, thanks!
* Subsequent characters in an identifier or key word can be letters, underscores, digits \(0-9\), or | ||
dollar signs \($\). | ||
|
||
Note that dollar signs are not allowed in identifiers according to the letter of the SQL standard, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
according to the letter of the SQL standard
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated, thanks!
still applies. | ||
* Quoting an identifier also makes it case-sensitive, whereas unquoted names are always folded to | ||
lower case. | ||
* If you want to write portable applications you are advised to always quote a particular name or |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Rephrase: In order to make your applications portable and less error-prone, use consistent quoting with each name (either always quote it or never quote it).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated, thanks!
* If you want to write portable applications you are advised to always quote a particular name or | ||
never quote it. | ||
|
||
Therefore, Airbyte Postgres destination will create tables and schemas using the Unquoted |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Therefore Note, that
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated, thanks!
|
||
#### Output Schema | ||
|
||
Each stream will be output into its own table in Postgres. Each table will contain 3 columns: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Rephrase: Each stream will be mapped to a separate table in Postgres.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated, thanks!
…emplate (#12279) * Updated postgres.md documentation as per BETA template
What
Documentation didn't correspond to the template
How
Updated documentation for connector
🚨 User Impact 🚨
No users impact
Pre-merge Checklist
Expand the relevant checklist and delete the others.
New Connector
Community member or Airbyter
airbyte_secret
./gradlew :airbyte-integrations:connectors:<name>:integrationTest
.README.md
bootstrap.md
. See description and examplesdocs/SUMMARY.md
docs/integrations/<source or destination>/<name>.md
including changelog. See changelog exampledocs/integrations/README.md
airbyte-integrations/builds.md
Airbyter
If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.
/test connector=connectors/<name>
command is passing/publish
command described hereUpdating a connector
Community member or Airbyter
airbyte_secret
./gradlew :airbyte-integrations:connectors:<name>:integrationTest
.README.md
bootstrap.md
. See description and examplesdocs/integrations/<source or destination>/<name>.md
including changelog. See changelog exampleAirbyter
If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.
/test connector=connectors/<name>
command is passing/publish
command described hereConnector Generator
-scaffold
in their name) have been updated with the latest scaffold by running./gradlew :airbyte-integrations:connector-templates:generator:testScaffoldTemplates
then checking in your changesTests
Unit
Put your unit tests output here.
Integration
Put your integration tests output here.
Acceptance
Put your acceptance tests output here.