MS SQL Server
Introduction
Hasura allows connecting to a SQL Server database and build a GraphQL API based on the database schema.
- Hasura GraphQL Engine
v2.0.0-alpha.2
onwards - SQL Server 2016 and upwards
Get Started
To try Hasura with SQL Server, you'll need your own new or existing SQL Server database.
Here are 2 ways you can get started with Hasura and SQL Server:
- Hasura Cloud: You'll need to be able to access your SQL Server database from Hasura Cloud.
- Docker: Run Hasura with Docker and then connect your SQL Server database to Hasura.
Supported features
Hasura currently supports queries, subscriptions, mutations, relationships, permissions, and Event Triggers on MS SQL Server.
Managing data with the Hasura Console
The Hasura Console is a web UI that allows you to manage your data and metadata. It is available at
http://localhost:8080/console
when you run Hasura locally, or from your project's Console endpoint when you use
Hasura Cloud.
The data-management features (such as creating tables) are available in the Data
tab. You can access your GraphQL API
in the API
tab and interact with it using the GraphiQL interface.
We recommend using your preferred MS SQL Server client instead. The Hasura Console is designed to be a tool for managing your GraphQL API, and not a full-fledged database management tool.
Required permissions
Assuming a CONNECT
permission already exists, the following permissions are required for Hasura to function
completely. Note that missing permissions may cause the corresponding features to work incorrectly:
- To use the Hasura Console to alter your schema, you will need appropriate schema permissions, such as
CREATE TABLE
,CREATE VIEW
,CREATE FUNCTION
, andCREATE PROCEDURE
, depending on what you want to do. - To perform queries and mutations, Hasura will need permission to
DELETE
,INSERT
,SELECT
, andUPDATE
. - To call MSSQL stored procedures via Hasura, the
EXECUTE
permission is also required.
Keep up to date
If you'd like to stay informed about the status of SQL Server support, subscribe to our newsletter and join our discord!
This Hands-on Demo walks you through Getting Started with Hasura on SQL Server & common use cases. - View Recording here.
We also have a tutorial available on our Learn site - check out the Microsoft SQL Server tutorial.