Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test automated connector publication #305

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 112 additions & 0 deletions registry/hasura/newtestconnector/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
# SQL Server Connector

[![Docs](https://img.shields.io/badge/docs-v3.x-brightgreen.svg?style=flat)](https://hasura.io/docs/3.0)
[![ndc-hub](https://img.shields.io/badge/ndc--hub-sqlserver-blue.svg?style=flat)](https://hasura.io/connectors/sqlserver)
[![License](https://img.shields.io/badge/license-Apache--2.0-purple.svg?style=flat)](LICENSE.txt)
[![Status](https://img.shields.io/badge/status-alpha-yellow.svg?style=flat)](./readme.md)

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](https://github.com/hasura/ndc-hub#rusk-sdk) and implements
the [Data Connector Spec](https://github.com/hasura/ndc-spec).

- [See the listing in the Hasura Hub](https://hasura.io/connectors/sqlserver)
- [Hasura V3 Documentation](https://hasura.io/docs/3.0/)

## Features

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 | ❌ | |

## Before you get Started

1. Create a [Hasura Cloud account](https://console.hasura.io)
2. Please ensure you have the [DDN CLI](https://hasura.io/docs/3.0/cli/installation) and [Docker](https://docs.docker.com/engine/install/) installed
3. [Create a supergraph](https://hasura.io/docs/3.0/getting-started/init-supergraph)
4. [Create a subgraph](https://hasura.io/docs/3.0/getting-started/init-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](https://hasura.io/docs/3.0/getting-started/deployment/deploy-a-connector).

## Using the SQL Server connector

### Step 1: Authenticate your CLI session

```bash
ddn auth login
```

### Step 2: Configure the connector

Once you have an initialized supergraph and subgraph, run the initialization command in interactive mode while
providing a name for the connector in the prompt:

```bash
ddn connector init <connector-name> -i
```

#### Step 2.1: Choose the `hasura/sqlserver` from the list

#### Step 2.2: Choose a port for the connector

The 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.

#### Step 2.3: Provide the env vars for the connector

| Name | Description | Required | Default |
|----------------|--------------------------------------------------|----------|---------|
| CONNECTION_URI | The connection string of the SQL Server database | Yes | N/A |

## Step 3: Introspect the connector

```bash
ddn connector introspect <connector-name>
```

This will generate a `configuration.json` file that will have the schema of your SQL Server database.

## Step 4: Add your resources

```bash
ddn connector-link add-resources <connector-name>
```

This command will track all the containers in your SQL Server DB as [Models](https://hasura.io/docs/3.0/supergraph-modeling/models).

## Documentation

View the full documentation for the ndc-sqlserver connector [here](./docs/readme.md).

## Contributing

We're happy to receive any contributions from the community. Please refer to our [development guide](./docs/development.md).

## License

The Hasura SQL Server connector is available under the [Apache License
2.0](https://www.apache.org/licenses/LICENSE-2.0).
Binary file added registry/hasura/newtestconnector/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
73 changes: 73 additions & 0 deletions registry/hasura/newtestconnector/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
{
"overview": {
"namespace": "hasura",
"description": "Connect to a SQL Server database and expose it to Hasura v3 Project",
"title": "New Test Connector",
"logo": "logo.png",
"tags": ["database"],
"latest_version": "v0.2.1"
},
"author": {
"support_email": "[email protected]",
"homepage": "https://hasura.io",
"name": "Hasura"
},
"is_verified": true,
"is_hosted_by_hasura": true,
"packages": [
{
"version": "0.1.2",
"uri": "https://github.com/hasura/ndc-sqlserver/releases/download/v0.1.2/package.tar.gz",
"checksum": {
"type": "sha256",
"value": "102c642b2e0ddea1eaa471c5189ecd3423a20f91ad83995e09f9d4721dd85732"
},
"source": {
"hash": "bc0fd3d126f6c142587e014aa900fc6bc90cd59d"
}
},
{
"version": "0.1.1",
"uri": "https://github.com/hasura/ndc-sqlserver/releases/download/v0.1.1/package.tar.gz",
"checksum": {
"type": "sha256",
"value": "340f11a2dbc180af838327c09949ac0dc14c94eb87b0d6b5a28c765ec928b1a9"
},
"source": {
"hash": "638a2b608f7a9c4625de7df35c61c909d2ce16b1"
}
},
{
"version": "0.1.0",
"uri": "https://github.com/hasura/ndc-sqlserver/releases/download/v0.1.0/package.tar.gz",
"checksum": {
"type": "sha256",
"value": "5f47a1df3055b694ffaf13058e201ac0fa83db53ce2044cd15eeaaa841565cb4"
},
"source": {
"hash": "e26d6bd1a22540dcf5c5b29460260c2d23ff2657"
}
}
],
"source_code": {
"is_open_source": true,
"repository": "https://github.com/hasura/ndc-sqlserver/",
"version": [
{
"tag": "v0.1.2",
"hash": "bc0fd3d126f6c142587e014aa900fc6bc90cd59d",
"is_verified": true
},
{
"tag": "v0.1.1",
"hash": "638a2b608f7a9c4625de7df35c61c909d2ce16b1",
"is_verified": true
},
{
"tag": "v0.1.0",
"hash": "e26d6bd1a22540dcf5c5b29460260c2d23ff2657",
"is_verified": true
}
]
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"version": "0.1.0",
"uri": "https://github.com/hasura/ndc-sqlserver/releases/download/v0.1.0/package.tar.gz",
"checksum": {
"type": "sha256",
"value": "5f47a1df3055b694ffaf13058e201ac0fa83db53ce2044cd15eeaaa841565cb4"
},
"source": {
"hash": "e26d6bd1a22540dcf5c5b29460260c2d23ff2657"
}
}
Loading