hasura/graphql-engine
1
0
Fork 0
mirror of https://github.com/hasura/graphql-engine.git synced 2024-09-11 10:46:25 +03:00
Code Issues Projects Releases Wiki Activity

docs: hotfix backprot to resolve modified links

Browse Source 
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10294
GitOrigin-RevId: e67f093d2c7a7793ce9b69618dae1165b2c5af15
This commit is contained in:
Rob Dominguez 2023-09-11 10:38:53 -05:00 committed by hasura-bot
parent 158fc16a1c
commit 52d05b0e9d
3 changed files with 41 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
docs/docs/schema/mongodb/logical-models.mdx
View File

@ -25,29 +25,41 @@ Full support for Logical Models on MongoDB are supported from `v2.31.0` onwards.
Logical Models are a GraphQL representation of database data. They provide an abstraction over the underlying database.
Logical Models are currently used by MongoDB as the primary method for defining a Collection or View's schema which will be used to generate the GraphQL API.
Since NoSQL databases don't inherently have a schema present for the Documents present, we need to define one for our Collections as they are added in Hasura.
Logical Models are currently used by MongoDB as the primary method for defining a Collection or View's schema which will
be used to generate the GraphQL API. Since NoSQL databases don't inherently have a schema present for the Documents
present, we need to define one for our Collections as they are added in Hasura.
You can find examples of how to use Logical Models in the
[Cloud](/databases/mongodb/cloud.mdx) or [Docker](/databases/mongodb/docker.mdx) Getting Started guides for MongoDB. For a more detailed explanation
of Logical Models themselves, read on.
You can find examples of how to use Logical Models in the [Cloud](/databases/mongodb/cloud.mdx) or
[Docker](/databases/mongodb/docker.mdx) Getting Started guides for MongoDB. For a more detailed explanation of Logical
Models themselves, read on.
## Tracking a Collection with a Logical Model
Each Collection needs to have a Logical Model in order to specify its GraphQL schema.<br />
A Logical model if optional if a Collection has a database [validation schema](https://www.mongodb.com/docs/upcoming/core/schema-validation/specify-json-schema/#std-label-schema-validation-json) present, it will be used as the default.
Each Collection needs to have a Logical Model in order to specify its GraphQL schema.<br /> A Logical model if optional
if a Collection has a database
[validation schema](https://www.mongodb.com/docs/upcoming/core/schema-validation/specify-json-schema/#std-label-schema-validation-json)
present, it will be used as the default.
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
<Thumbnail src="/img/databases/mongodb/track-1-select.png" alt="Tracking a Collection - Select Collection" width="1000px" />
<Thumbnail src="/img/databases/mongodb/track-2-sample.png" alt="Tracking a Collection - Sample Documents" width="1000px" />
<Thumbnail
src="/img/databases/mongodb/track-1-select.png"
alt="Tracking a Collection - Select Collection"
width="1000px"
/>
<Thumbnail
src="/img/databases/mongodb/track-2-sample.png"
alt="Tracking a Collection - Sample Documents"
width="1000px"
/>
</TabItem>
<TabItem value="cli" label="CLI">
You can create a logical model by adding it to the appropriate database definition in the `metadata > databases > databases.yaml` file:
You can create a logical model by adding it to the appropriate database definition in the
`metadata > databases > databases.yaml` file:
```yaml
logical_models:
@ -60,7 +72,8 @@ You can create a logical model by adding it to the appropriate database definiti
...
```
And the track the Collection with its associated logical model by adding the definition to `metadata > databases > tables > <collection_name>.yaml`.
And the track the Collection with its associated logical model by adding the definition to
`metadata > databases > tables > <collection_name>.yaml`.
```yaml
table:
@ -71,7 +84,7 @@ logical_model: <logical_model_name>
There will also be an associated `includes` statement in the `metadata > databases > tables > tables.yaml` file.
```yaml
- "!include <table_name>.yaml"
- '!include <table_name>.yaml'
```
</TabItem>
@ -106,7 +119,6 @@ X-Hasura-Role: admin
</TabItem>
</Tabs>
## Tracking a Logical Model
<Tabs groupId="user-preference" className="api-tabs">
@ -122,7 +134,8 @@ X-Hasura-Role: admin
<TabItem value="cli" label="CLI">
You can create a logical model by adding it to the appropriate model definition, under the database in the `metadata > databases > databases.yaml` file:
You can create a logical model by adding it to the appropriate model definition, under the database in the
`metadata > databases > databases.yaml` file:
```yaml
logical_models:
@ -500,7 +513,7 @@ can receive.
Columns must be specified, though you can use `"*"` to specify that you want to allow all columns.
The filter is the same boolean expression syntax as [query filters](/queries/ms-sql-server/query-filters.mdx). To allow
The filter is the same boolean expression syntax as [query filters](/queries/ms-sql-server/filters/index.mdx). To allow
all rows to be passed through to the response, you can specify an empty filter, `{}`.
Add the required permissions to the relevant logical model in `metadata > databases > databases.yaml`:
@ -528,7 +541,7 @@ Add the required permissions to the relevant logical model in `metadata > databa
Columns must be specified, though you can use `"*"` to specify that you want to allow all columns.
The filter is the same boolean expression syntax as [query filters](/queries/ms-sql-server/query-filters.mdx). To allow
The filter is the same boolean expression syntax as [query filters](/queries/ms-sql-server/filters/index.mdx). To allow
all rows to be passed through to the response, you can specify an empty filter, `{}`.
```http

24
docs/docs/schema/snowflake/logical-models.mdx
View File

@ -28,19 +28,16 @@ Logical Models are supported from `v2.33.0`.
Logical Models are a GraphQL representation of database data. They provide an abstraction over the underlying database.
Logical Models are a new approach from Hasura and are currently used by the
[Native Queries](/schema/snowflake/native-queries.mdx) and the
GraphQL API for a native database query.
[Native Queries](/schema/snowflake/native-queries.mdx) and the GraphQL API for a native database query.
You can find examples of how to use Logical Models in the
[Native Queries](/schema/snowflake/native-queries.mdx) documentation. For a more detailed explanation
of Logical Models themselves, read on.
You can find examples of how to use Logical Models in the [Native Queries](/schema/snowflake/native-queries.mdx)
documentation. For a more detailed explanation of Logical Models themselves, read on.
## Tracking a Logical Model
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
You can create a Logical Model from the "Data" tab of the Console, by clicking on `Native Queries` in the sidebar, then
`Add Logical Model`:
@ -50,8 +47,8 @@ You can create a Logical Model from the "Data" tab of the Console, by clicking o
<TabItem value="cli" label="CLI">
You can create a logical model by adding it to the appropriate database definition in the `metadata > databases > databases.yaml`
file:
You can create a logical model by adding it to the appropriate database definition in the
`metadata > databases > databases.yaml` file:
```yaml
logical_models:
@ -96,9 +93,10 @@ X-Hasura-Role: admin
</TabItem>
</Tabs>
The type of each field can be either a [Snowflake data type](https://docs.snowflake.com/en/sql-reference/intro-summary-data-types)
or references to other Logical Models, and each field can be marked as nullable or not,
see [LogicalModelType](/api-reference/syntax-defs.mdx#logicalmodeltype).
The type of each field can be either a
[Snowflake data type](https://docs.snowflake.com/en/sql-reference/intro-summary-data-types) or references to other
Logical Models, and each field can be marked as nullable or not, see
[LogicalModelType](/api-reference/syntax-defs.mdx#logicalmodeltype).
For example, we could track a representation of an article as follows:
@ -410,7 +408,7 @@ can receive.
Columns must be specified, though you can use `"*"` to specify that you want to allow all columns.
The filter is the same boolean expression syntax as [query filters](/queries/ms-sql-server/query-filters.mdx). To allow
The filter is the same boolean expression syntax as [query filters](/queries/ms-sql-server/filters/index.mdx). To allow
all rows to be passed through to the response, you can specify an empty filter, `{}`.
Add the required permissions to the relevant logical model in `metadata > databases > databases.yaml`:
@ -438,7 +436,7 @@ Add the required permissions to the relevant logical model in `metadata > databa
Columns must be specified, though you can use `"*"` to specify that you want to allow all columns.
The filter is the same boolean expression syntax as [query filters](/queries/ms-sql-server/query-filters.mdx). To allow
The filter is the same boolean expression syntax as [query filters](/queries/ms-sql-server/filters/index.mdx). To allow
all rows to be passed through to the response, you can specify an empty filter, `{}`.
```http

2
docs/docs/schema/snowflake/native-queries.mdx
View File

@ -528,7 +528,7 @@ query {
## Query functionality
Just like tables, Native Queries generate GraphQL types with the ability to further break down the data. You can find
more information in the relevant documentation for [filtering](/queries/ms-sql-server/query-filters.mdx),
more information in the relevant documentation for [filtering](/queries/ms-sql-server/filters/index.mdx),
[sorting](/queries/ms-sql-server/sorting.mdx), and [pagination](/queries/ms-sql-server/pagination.mdx).
Subscriptions (live queries) are also supported as usual.