Add configuration for addressing Redshift servers

Adds clusterIdentifier, host, port and endpoint to give more options for addressing a Redshift output port. Add documentation and examples to README.
datacontract · Oct 3, 2024 · 98e7099 · 98e7099
1 parent ef41312
commit 98e7099
Show file tree

Hide file tree

Showing 3 changed files with 77 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -23,6 +23,7 @@ The public API SHOULD NOT be considered stable.
 - Trino support
 - Field `type: map` support with properties `keys` and `values`
 - Definitions: `fields`, for type `object`, `record`, and `struct`
+- Add Redshift server properties `clusterIdentifier`, `endpoint`, `host` and `port`.
 
 ## [0.9.3] - 2024-03-06
 

diff --git a/README.md b/README.md
@@ -409,12 +409,51 @@ servers:
 
 #### Redshift Server Object
 
-| Field    | Type     | Description |
-|----------|----------|-------------|
-| type     | `string` | `redshift`  |
-| account  | `string` |             |
-| database | `string` |             |
-| schema   | `string` |             |
+| Field             | Type     | Description                                                                                                         |
+|-------------------|----------|---------------------------------------------------------------------------------------------------------------------|
+| type              | `string` | `redshift`                                                                                                          |
+| account           | `string` |                                                                                                                     |
+| database          | `string` |                                                                                                                     |
+| schema            | `string` |                                                                                                                     |
+| clusterIdentifier | `string` | Identifier of the cluster. <br /> Example: `analytics-cluster`                                                      |
+| host              | `string` | Host of the cluster. <br /> Example: `analytics-cluster.example.eu-west-1.redshift.amazonaws.com`                   |
+| port              | `number` | Port of the cluster. <br /> Example: `5439`                                                                         |
+| endpoint          | `string` | Endpoint of the cluster <br /> Example: `analytics-cluster.example.eu-west-1.redshift.amazonaws.com:5439/analytics` |
+
+Example, specifying an endpoint:
+
+```yaml
+servers:
+  analytics:
+    type: redshift
+    schema: analytics
+    endpoint: analytics-cluster.example.eu-west-1.redshift.amazonaws.com:5439/analytics
+```
+
+Example, specifying the cluster identifier:
+
+```yaml
+servers:
+  analytics:
+    type: redshift
+    account: '123456789012'
+    clusterIdentifier: analytics-cluster
+    database: analytics
+    port: 5439
+    schema: analytics
+```
+
+Example, specifying the cluster host:
+
+```yaml
+servers:
+  analytics:
+    type: redshift
+    host: analytics-cluster.example.eu-west-1.redshift.amazonaws.com
+    database: analytics
+    port: 5439
+    schema: analytics
+```
 
 #### Azure Server Object
 

diff --git a/datacontract.schema.json b/datacontract.schema.json
@@ -272,21 +272,51 @@
                 "type": "string",
                 "description": "An optional string describing the server."
               },
+              "host": {
+                "type": "string",
+                "description": "An optional string describing the host name."
+              },
               "database": {
                 "type": "string",
                 "description": "An optional string describing the server."
               },
               "schema": {
                 "type": "string",
                 "description": "An optional string describing the server."
+              },
+              "clusterIdentifier": {
+                "type": "string",
+                "description": "An optional string describing the cluster's identifier.",
+                "examples": [
+                  "redshift-prod-eu",
+                  "analytics-cluster"
+                ]
+              },
+              "port": {
+                "type": "integer",
+                "description": "An optional string describing the cluster's port.",
+                "examples": [
+                  5439
+                ]
+              },
+              "endpoint": {
+                "type": "string",
+                "description": "An optional string describing the cluster's endpoint.",
+                "examples": [
+                  "analytics-cluster.example.eu-west-1.redshift.amazonaws.com:5439/analytics"
+                ]
               }
             },
             "additionalProperties": true,
             "required": [
               "type",
               "account",
+              "host",
               "database",
-              "schema"
+              "schema",
+              "clusterIdentifier",
+              "port",
+              "endpoint"
             ]
           },
           {