hasura/graphql-engine
1
0
Fork 0
mirror of https://github.com/hasura/graphql-engine.git synced 2024-12-14 17:02:49 +03:00
Code Issues Projects Releases Wiki Activity

Add documentation for *_get_source_tables

Browse Source 
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8986
GitOrigin-RevId: 1caa507a41bbc5066cd5ae475c669af4cb2f3020
This commit is contained in:
Tom Harding 2023-05-01 10:39:55 +01:00 committed by hasura-bot
parent 8bf1d9cd4d
commit 6f7458a7c5
2 changed files with 46 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docs/api-reference/metadata-api/index.mdx
View File

@ -73,6 +73,7 @@ The various types of queries are listed in the following table:
| **bulk_keep_going** | [Query](#metadata-query) array | 1 | Like `bulk`, but subcommands can fail without the whole batch failing |
| [pg_add_source](/api-reference/metadata-api/source.mdx#metadata-pg-add-source) | [pg_add_source_args](/api-reference/metadata-api/source.mdx#metadata-pg-add-source-syntax) | 1 | Add a Postgres database |
| [pg_drop_source](/api-reference/metadata-api/source.mdx#metadata-pg-drop-source) | [pg_drop_source_args](/api-reference/metadata-api/source.mdx#metadata-pg-drop-source-syntax) | 1 | Remove a Postgres database |
| [pg_get_source_tables](/api-reference/metadata-api/source.mdx#metadata-pg-get-source-tables) | [pg_get_source_tables_args](/api-reference/metadata-api/source.mdx#metadata-pg-get-source-tables-syntax) | 1 | List all tables available on a given Postgres database |
| [pg_track_table](/api-reference/metadata-api/table-view.mdx#metadata-pg-track-table) | [pg_track_table_args](/api-reference/metadata-api/table-view.mdx#metadata-pg-track-table-syntax) | 1 | Add a Postgres table/view with configuration |
| [pg_untrack_table](/api-reference/metadata-api/table-view.mdx#metadata-pg-untrack-table) | [pg_untrack_table_args](/api-reference/metadata-api/table-view.mdx#metadata-pg-untrack-table-syntax) | 1 | Remove a Postgres table/view |
| [pg_update_source](/api-reference/metadata-api/source.mdx#metadata-pg-update-source) | [pg_update_source_args](/api-reference/metadata-api/source.mdx#metadata-pg-update-source-syntax) | 1 | Update a Postgres database |
@ -113,6 +114,7 @@ The various types of queries are listed in the following table:
| [bigquery_set_apollo_federation_config](/api-reference/metadata-api/table-view.mdx#metadata-bigquery-set-apollo-federation-config) | [bigquery_set_apollo_federation_config_args](/api-reference/metadata-api/table-view.mdx#metadata-bigquery-set-apollo-federation-config-syntax) | 1 | Set Apollo Federation configuration of an already tracked bigquery table |
| [mssql_add_source](/api-reference/metadata-api/source.mdx#mssql-add-source) | [mssql_add_source_args](/api-reference/metadata-api/source.mdx#mssql-add-source-syntax) | 1 | Add an MS SQL Server database |
| [mssql_drop_source](/api-reference/metadata-api/source.mdx#mssql-drop-source) | [mssql_drop_source_args](/api-reference/metadata-api/source.mdx#mssql-drop-source-syntax) | 1 | Remove an MS SQL Server database |
| [mssql_get_source_tables](/api-reference/metadata-api/source.mdx#mssql-get-source-tables) | [mssql_get_source_tables_args](/api-reference/metadata-api/source.mdx#mssql-get-source-tables-syntax) | 1 | List all tables available on a given MS SQL Server database |
| [mssql_track_table](/api-reference/metadata-api/table-view.mdx#mssql-track-table) | [mssql_track_table_args](/api-reference/metadata-api/table-view.mdx#mssql-track-table-syntax) | 1 | Add an MS SQL Server table/view with configuration |
| [mssql_untrack_table](/api-reference/metadata-api/table-view.mdx#mssql-untrack-table) | [mssql_untrack_table_args](/api-reference/metadata-api/table-view.mdx#mssql-untrack-table-syntax) | 1 | Remove an MS SQL Server table/view |
| [mssql_update_source](/api-reference/metadata-api/source.mdx#mssql-update-source) | [mssql_update_source_args](/api-reference/metadata-api/source.mdx#mssql-update-source-syntax) | 1 | Update an MS SQL Server database |

44
docs/docs/api-reference/metadata-api/source.mdx
View File

@ -135,6 +135,28 @@ X-Hasura-Role: admin
| name | true | [SourceName](/api-reference/syntax-defs.mdx#sourcename) | Name of the Postgres database |
| cascade | false | Boolean | When set to `true`, the effect (if possible) is cascaded to any Metadata dependent objects (relationships, permissions etc.) from other sources (default: `false`) |
## pg_get_source_tables {#metadata-pg-get-source-tables}
`pg_get_source_tables` is used to list the tables available on a given Postgres
database.
List the tables available on a database with name `pg1`:
```http
{
"type": "pg_get_source_tables",
"args": {
"source": "pg1"
}
}
```
### Args syntax {#metadata-pg-get-source-tables-syntax}
| Key | Required | Schema | Description |
| ------ | -------- | ------------------------------------------------------- | ------------------------------|
| source | true | [SourceName](/api-reference/syntax-defs.mdx#sourcename) | Name of the Postgres database |
## rename_source {#metadata-rename-source}
`rename_source` is used to rename an existing source.
@ -302,6 +324,28 @@ X-Hasura-Role: admin
| name | true | [SourceName](/api-reference/syntax-defs.mdx#sourcename) | Name of the MS SQL Server database |
| cascade | false | Boolean | When set to `true`, the effect (if possible) is cascaded to any Metadata dependent objects (relationships, permissions etc.) from other sources (default: `false`) |
## mssql_get_source_tables {#mssql-get-source-tables}
`mssql_get_source_tables` is used to list the tables available on a given
MS SQL Server database.
List the tables available on a database with name `mssql1`:
```http
{
"type": "mssql_get_source_tables",
"args": {
"source": "mssql1"
}
}
```
### Args syntax {#mssql-get-source-tables-syntax}
| Key | Required | Schema | Description |
| ------ | -------- | ------------------------------------------------------- | ---------------------------------- |
| source | true | [SourceName](/api-reference/syntax-defs.mdx#sourcename) | Name of the MS SQL Server database |
## mssql_update_source {#mssql-update-source}
`mssql_update_source` is used to update an already existing MS SQL Server source in Hasura.