diff --git a/docs/server/ongoing-tasks/etl/queue-etl/overview.mdx b/docs/server/ongoing-tasks/etl/queue-etl/overview.mdx index 3728ac665a..70e557937d 100644 --- a/docs/server/ongoing-tasks/etl/queue-etl/overview.mdx +++ b/docs/server/ongoing-tasks/etl/queue-etl/overview.mdx @@ -112,12 +112,20 @@ The above ETL tasks: | **type** | `string` | [Event type](https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#type) | "ravendb.etl.put" | | **source** | `string` | [Event context](https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#source-1) | `//` | -* The optional 'partitionkey' attribute can also be added. - Currently, it is only implemented by [Kafka ETL](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx). +* The following [optional attributes](https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#optional-attributes) can also be specified: - | Optional Attribute | Type | Description | Default Value | - |----------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------|------------------| - | **partitionkey** | `string` | [Events relationship/grouping definition](https://github.com/cloudevents/spec/blob/main/cloudevents/extensions/partitioning.md#partitionkey) | The document ID | + | Optional Attribute | Type | Description | Default Value | + |--------------------|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| + | **partitionkey** | `string` | [Events relationship/grouping definition](https://github.com/cloudevents/spec/blob/main/cloudevents/extensions/partitioning.md#partitionkey) | The document ID | + | **dataschema** | `URI` | [Identifies the schema that data adheres to](https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#dataschema) | None | + | **subject** | `string` | [Describes the subject of the event in the context of the event producer](https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#subject) | None | + | **time** | `Timestamp` | [Timestamp of when the occurrence happened](https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#time) | None | + + +The `partitionkey` attribute is a [CloudEvents partitioning extension](https://github.com/cloudevents/spec/blob/main/cloudevents/extensions/partitioning.md). +For [Kafka ETL](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx), it controls which partition the message is routed to. +For other queue brokers, it is included as message metadata but has no routing effect. + diff --git a/versioned_docs/version-6.2/server/ongoing-tasks/etl/queue-etl/overview.mdx b/versioned_docs/version-6.2/server/ongoing-tasks/etl/queue-etl/overview.mdx index 158655ee11..b62f1f5ab3 100644 --- a/versioned_docs/version-6.2/server/ongoing-tasks/etl/queue-etl/overview.mdx +++ b/versioned_docs/version-6.2/server/ongoing-tasks/etl/queue-etl/overview.mdx @@ -107,12 +107,20 @@ The above ETL tasks: | **type** | `string` | [Event type](https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#type) | "ravendb.etl.put" | | **source** | `string` | [Event context](https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#source-1) | `//` | -* The optional 'partitionkey' attribute can also be added. - Currently, it is only implemented by [Kafka ETL](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx). +* The following [optional attributes](https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#optional-attributes) can also be specified: - | Optional Attribute | Type | Description | Default Value | - |----------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------|------------------| - | **partitionkey** | `string` | [Events relationship/grouping definition](https://github.com/cloudevents/spec/blob/main/cloudevents/extensions/partitioning.md#partitionkey) | The document ID | + | Optional Attribute | Type | Description | Default Value | + |--------------------|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| + | **partitionkey** | `string` | [Events relationship/grouping definition](https://github.com/cloudevents/spec/blob/main/cloudevents/extensions/partitioning.md#partitionkey) | The document ID | + | **dataschema** | `URI` | [Identifies the schema that data adheres to](https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#dataschema) | None | + | **subject** | `string` | [Describes the subject of the event in the context of the event producer](https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#subject) | None | + | **time** | `Timestamp` | [Timestamp of when the occurrence happened](https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#time) | None | + + +The `partitionkey` attribute is a [CloudEvents partitioning extension](https://github.com/cloudevents/spec/blob/main/cloudevents/extensions/partitioning.md). +For [Kafka ETL](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx), it controls which partition the message is routed to. +For other queue brokers, it is included as message metadata but has no routing effect. + diff --git a/versioned_docs/version-7.0/server/ongoing-tasks/etl/queue-etl/overview.mdx b/versioned_docs/version-7.0/server/ongoing-tasks/etl/queue-etl/overview.mdx index 76949f2909..bd9c87054c 100644 --- a/versioned_docs/version-7.0/server/ongoing-tasks/etl/queue-etl/overview.mdx +++ b/versioned_docs/version-7.0/server/ongoing-tasks/etl/queue-etl/overview.mdx @@ -111,12 +111,20 @@ The above ETL tasks: | **type** | `string` | [Event type](https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#type) | "ravendb.etl.put" | | **source** | `string` | [Event context](https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#source-1) | `//` | -* The optional 'partitionkey' attribute can also be added. - Currently, it is only implemented by [Kafka ETL](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx). +* The following [optional attributes](https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#optional-attributes) can also be specified: - | Optional Attribute | Type | Description | Default Value | - |----------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------|------------------| - | **partitionkey** | `string` | [Events relationship/grouping definition](https://github.com/cloudevents/spec/blob/main/cloudevents/extensions/partitioning.md#partitionkey) | The document ID | + | Optional Attribute | Type | Description | Default Value | + |--------------------|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| + | **partitionkey** | `string` | [Events relationship/grouping definition](https://github.com/cloudevents/spec/blob/main/cloudevents/extensions/partitioning.md#partitionkey) | The document ID | + | **dataschema** | `URI` | [Identifies the schema that data adheres to](https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#dataschema) | None | + | **subject** | `string` | [Describes the subject of the event in the context of the event producer](https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#subject) | None | + | **time** | `Timestamp` | [Timestamp of when the occurrence happened](https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#time) | None | + + +The `partitionkey` attribute is a [CloudEvents partitioning extension](https://github.com/cloudevents/spec/blob/main/cloudevents/extensions/partitioning.md). +For [Kafka ETL](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx), it controls which partition the message is routed to. +For other queue brokers, it is included as message metadata but has no routing effect. + diff --git a/versioned_docs/version-7.1/server/ongoing-tasks/etl/queue-etl/overview.mdx b/versioned_docs/version-7.1/server/ongoing-tasks/etl/queue-etl/overview.mdx index 76949f2909..bd9c87054c 100644 --- a/versioned_docs/version-7.1/server/ongoing-tasks/etl/queue-etl/overview.mdx +++ b/versioned_docs/version-7.1/server/ongoing-tasks/etl/queue-etl/overview.mdx @@ -111,12 +111,20 @@ The above ETL tasks: | **type** | `string` | [Event type](https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#type) | "ravendb.etl.put" | | **source** | `string` | [Event context](https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#source-1) | `//` | -* The optional 'partitionkey' attribute can also be added. - Currently, it is only implemented by [Kafka ETL](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx). +* The following [optional attributes](https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#optional-attributes) can also be specified: - | Optional Attribute | Type | Description | Default Value | - |----------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------|------------------| - | **partitionkey** | `string` | [Events relationship/grouping definition](https://github.com/cloudevents/spec/blob/main/cloudevents/extensions/partitioning.md#partitionkey) | The document ID | + | Optional Attribute | Type | Description | Default Value | + |--------------------|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| + | **partitionkey** | `string` | [Events relationship/grouping definition](https://github.com/cloudevents/spec/blob/main/cloudevents/extensions/partitioning.md#partitionkey) | The document ID | + | **dataschema** | `URI` | [Identifies the schema that data adheres to](https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#dataschema) | None | + | **subject** | `string` | [Describes the subject of the event in the context of the event producer](https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#subject) | None | + | **time** | `Timestamp` | [Timestamp of when the occurrence happened](https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#time) | None | + + +The `partitionkey` attribute is a [CloudEvents partitioning extension](https://github.com/cloudevents/spec/blob/main/cloudevents/extensions/partitioning.md). +For [Kafka ETL](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx), it controls which partition the message is routed to. +For other queue brokers, it is included as message metadata but has no routing effect. +