Merge branch 'main' into develop/v1

# Conflicts: # CHANGELOG.md # README.md # datacontract.schema.json
datacontract · Oct 30, 2024 · 73087bf · 73087bf
2 parents 41b1fcf + 7be96fa
commit 73087bf
Show file tree

Hide file tree

Showing 4 changed files with 80 additions and 396 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -27,7 +27,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Definitions: `fields`, for type `object`, `record`, and `struct`
 - Field `field.primaryKey` (Replaces `field.primary`)
 - Field `model.primaryKey` to describe a composite primary key
-
+- Add Redshift server properties `clusterIdentifier`, `endpoint`, `host` and `port`.
 
 ### Removed
 

diff --git a/README.md b/README.md
@@ -430,12 +430,53 @@ 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
+    account: '123456789012'
+    database: analytics
+    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'
+    database: analytics
+    schema: analytics
+    clusterIdentifier: analytics-cluster
+```
+
+Example, specifying the cluster host:
+
+```yaml
+servers:
+  analytics:
+    type: redshift
+    account: '123456789012'
+    database: analytics
+    schema: analytics
+    host: analytics-cluster.example.eu-west-1.redshift.amazonaws.com
+    port: 5439
+```
 
 #### Azure Server Object
 
@@ -690,7 +731,7 @@ One can either describe each service level informally using the `description` fi
 |--------------|-----------------------------------------------|-------------------------------------------------------------------------|
 | availability | [Availability Object](#availability-object)   | The promised uptime of the system that provides the data                |
 | retention    | [Retention Object](#retention-object)         | The period how long data will be available.                             |
-| latency      | [Latency Object](#latency-object)             | The maximum amount of time from the the source to its destination. |
+| latency      | [Latency Object](#latency-object)             | The maximum amount of time from the source to its destination. |
 | freshness    | [Freshness Object](#freshness-object)         | The maximum age of the youngest entry.                                  |
 | frequency    | [Frequency Object](#frequency-object)         | The update frequency.                                                   |
 | support      | [Support Object](#support-object)             | The times when support is provided.                                     |

diff --git a/datacontract.schema.json b/datacontract.schema.json
@@ -1261,15 +1261,42 @@
           "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": [
         "account",
         "database",