Skip to content
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.

Sign up for GitHub

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

Improve documentation for Postgres Source #13830

Merged
merged 4 commits into from
Jun 27, 2022
Merged

Improve documentation for Postgres Source #13830

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2495102
Improve documentation for Postgres Source
Jun 15, 2022
45803de
Revert the change in ssh-tunnel-spec.json, because it is injected in …
Jun 16, 2022
ade6297
Address review comments
Jun 16, 2022
b9b4487
Merge branch 'master' into greg/docs-and-specs-source-postgres
grishick Jun 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion airbyte-integrations/bases/base-java/src/main/resources/ssh-tunnel-spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"type": "object",
"title": "SSH Tunnel Method",
"description": "Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.",
"description": "Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. For more information read about <a href=\"https://docs.airbyte.com/integrations/sources/postgres#ssh-tunnel\">connection via SSH tunnel</a>.",
"oneOf": [
{
"title": "No Tunnel",
Expand Down Expand Up @@ -112,3 +112,4 @@
}
]
}

11 changes: 6 additions & 5 deletions airbyte-integrations/connectors/source-postgres/src/main/resources/spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@
"order": 5
},
"jdbc_url_params": {
"description": "Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3).",
"title": "JDBC URL Params",
"description": "Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3). Read <a href=\"https://docs.airbyte.com/integrations/sources/postgres#jdbc-url-params\">Postgres Source</a> docs for more information.",
"title": "JDBC URL Params (Advanced)",
"type": "string",
"order": 6
},
Expand Down Expand Up @@ -104,21 +104,21 @@
"plugin": {
"type": "string",
"title": "Plugin",
"description": "A logical decoding plug-in installed on the PostgreSQL server. `pgoutput` plug-in is used by default.\nIf replication table contains a lot of big jsonb values it is recommended to use `wal2json` plug-in. For more information about `wal2json` plug-in read <a href=\"https://docs.airbyte.com/integrations/sources/postgres\">Postgres Source</a> docs.",
"description": "A logical decoding plug-in installed on the PostgreSQL server. `pgoutput` plug-in is used by default.\nIf replication table contains a lot of big jsonb values it is recommended to use `wal2json` plug-in. For more information about `wal2json` plug-in read <a href=\"https://docs.airbyte.com/integrations/sources/postgres#replication-plugin\">Select replication plugin</a> in documentation.",
"enum": ["pgoutput", "wal2json"],
"default": "pgoutput",
"order": 1
},
"replication_slot": {
"type": "string",
"title": "Replication Slot",
"description": "A plug-in logical replication slot.",
"description": "A plug-in logical replication slot. For more information read about <a href=\"https://docs.airbyte.com/integrations/sources/postgres#replication-slot\">replication slots</a> in documentation.",
"order": 2
},
"publication": {
"type": "string",
"title": "Publication",
"description": "A Postgres publication used for consuming changes.",
"description": "A Postgres publication used for consuming changes. For more information read about <a href=\"https://docs.airbyte.com/integrations/sources/postgres#publications-replication\">publications and replication identities</a> in documentation.",
"order": 3
}
}
Expand All @@ -128,3 +128,4 @@
}
}
}

Loading