With this connector, Hasura allows you to instantly create a real-time GraphQL API on top of your data models in Microsoft SQL Server. This connector supports SQL Server's functionalities listed in the table below, allowing for efficient and scalable data operations. Additionally, users benefit from all the powerful features of Hasura’s Data Delivery Network (DDN) platform, including query pushdown capabilities that delegate query operations to the database, thereby enhancing query optimization and performance.
This connector is built using the Rust Data Connector SDK and implements the Data Connector Spec.
Below, you'll find a matrix of all supported features for the SQL Server connector:
| Feature | Supported | Notes |
|---|---|---|
| Native Queries + Logical Models | ✅ | |
| Native Mutations | ✅ | |
| Simple Object Query | ✅ | |
| Filter / Search | ✅ | |
| Simple Aggregation | ✅ | |
| Sort | ✅ | |
| Paginate | ✅ | |
| Table Relationships | ✅ | |
| Views | ✅ | |
| Remote Relationships | ✅ | |
| Stored Procedures | ✅ | |
| Custom Fields | ❌ | |
| Mutations | ❌ | Only native mutations are suppported |
| Distinct | ✅ | |
| Enums | ❌ | |
| Naming Conventions | ❌ | |
| Default Values | ❌ | |
| User-defined Functions | ❌ |
- Create a Hasura Cloud account
- Please ensure you have the DDN CLI and Docker installed
- Create a supergraph
- Create a subgraph
The steps below explain how to Initialize and configure a connector for local development. You can learn how to deploy a connector — after it's been configured — here.
ddn auth loginOnce you have an initialized supergraph and subgraph, run the initialization command in interactive mode while providing a name for the connector in the prompt:
ddn connector init <connector-name> -iThe CLI will ask for a specific port to run the connector on. Choose a port that is not already in use or use the default suggested port.
| Name | Description | Required | Default |
|---|---|---|---|
| CONNECTION_URI | The connection string of the SQL Server database | Yes | N/A |
ddn connector introspect <connector-name>This will generate a configuration.json file that will have the schema of your SQL Server database.
ddn connector-link add-resources <connector-name>This command will track all the containers in your SQL Server DB as Models.
View the full documentation for the ndc-sqlserver connector here.
We're happy to receive any contributions from the community. Please refer to our development guide.
The Hasura SQL Server connector is available under the Apache License 2.0.