Skip to content

Commit 0ec6f62

Browse files
author
Gil Mizrahi
authored
Update readme (#536)
### What There's a new template in town. Let's update the readme.
1 parent f59640c commit 0ec6f62

File tree

4 files changed

+30
-23
lines changed

4 files changed

+30
-23
lines changed

docs/architecture.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
The query engine's job is to take a `QueryRequest`, which contains information about the query a user would like to run,
66
translate it to PostgreSQL SQL, execute it against the database, and return the results as a `QueryResponse`.
77

8-
One place in particular that uses the Query Engine is the `/query` endpoint (defined in the `ndc-hub` repository).
8+
One place in particular that uses the Query Engine is the `/query` endpoint (defined in the `ndc-sdk-rs` repository).
99

1010
`/query` endpoints receives a `QueryRequest`, and calls the `translate` function from the Query Engine
1111
with it and with the information about the tables tracked in the metadata to receive and `ExecutionPlan`.
@@ -65,9 +65,9 @@ pub struct ExecutionPlan<Query> {
6565
/// The query we want to run with some additional information.
6666
pub struct Query {
6767
/// The root field name of the top-most collection.
68-
pub root_field: String,
68+
pub root_field: CollectionName,
6969
/// foreach variables.
70-
pub variables: Option<Vec<BTreeMap<String, serde_json::Value>>>,
70+
pub variables: Option<Vec<BTreeMap<ArgumentName, serde_json::Value>>>,
7171
/// The query.
7272
pub query: sql::ast::Select,
7373
}

docs/readme.md

-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
`ndc-postgres` is a [Hasura](https://hasura.io/) connector for PostgreSQL.
44

5-
- [Usage](./usage.md)
65
- [Architecture](./architecture.md)
76
- [Code of Conduct](./code-of-conduct.md)
87
- [Debugging](./debugging.md)

docs/usage.md

-18
This file was deleted.

readme.md

+27-1
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,38 @@
1010
The Hasura PostgreSQL Connector allows for connecting to a PostgreSQL database giving you an instant
1111
GraphQL API on top of your PostgreSQL data.
1212

13-
This connector is built using the [Rust Data Connector SDK](https://github.com/hasura/ndc-hub#rust-sdk)
13+
This connector is built using the [Rust Data Connector SDK](https://github.com/hasura/ndc-sdk-rs)
1414
and implements the [Data Connector Spec](https://github.com/hasura/ndc-spec).
1515

1616
- [Connector information in the Hasura Hub](https://hasura.io/connectors/postgres)
1717
- [Hasura V3 Documentation](https://hasura.io/docs/3.0)
1818

19+
## Features
20+
21+
Below, you'll find a matrix of all supported features for the PostgreSQL connector:
22+
23+
| Feature | Supported |
24+
| ---------------------- | --------- |
25+
| Native Queries ||
26+
| Native Mutations ||
27+
| Simple Object Query ||
28+
| Filter / Search ||
29+
| Simple Aggregation ||
30+
| Sort ||
31+
| Paginate ||
32+
| Table Relationships ||
33+
| Views ||
34+
| Mutations ||
35+
| Distinct ||
36+
| Enums ||
37+
| Default Values ||
38+
| User-defined Functions ||
39+
40+
## Using the PostgreSQL connector
41+
42+
Hasura DDN's [Getting Started](https://hasura.io/docs/3.0/getting-started/build/connect-to-data/connect-a-source?db=PostgreSQL)
43+
guide contains information about how to use the PostgreSQL connector as part of a Hasura DDN project.
44+
1945
## Support & Troubleshooting
2046

2147
The documentation and community will help you troubleshoot most issues.

0 commit comments

Comments
 (0)