Skip to content

RDoc-3812 - queue ETL - explain which optional CloudEvents attributes can be specified #2438

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.

Sign up for GitHub

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

Open
reebhub wants to merge 1 commit into
base: main
Choose a base branch
from
Open

RDoc-3812 - queue ETL - explain which optional CloudEvents attributes can be specified #2438

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 13 additions & 5 deletions docs/server/ongoing-tasks/etl/queue-etl/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) | `<ravendb-node-url>/<database-name>/<etl-task-name>` |

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

<Admonition type="note" title="">
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.
</Admonition>



Expand Down
18 changes: 13 additions & 5 deletions versioned_docs/version-6.2/server/ongoing-tasks/etl/queue-etl/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) | `<ravendb-node-url>/<database-name>/<etl-task-name>` |

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

<Admonition type="note" title="">
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.
</Admonition>



Expand Down
18 changes: 13 additions & 5 deletions versioned_docs/version-7.0/server/ongoing-tasks/etl/queue-etl/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) | `<ravendb-node-url>/<database-name>/<etl-task-name>` |

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

<Admonition type="note" title="">
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.
</Admonition>



Expand Down
18 changes: 13 additions & 5 deletions versioned_docs/version-7.1/server/ongoing-tasks/etl/queue-etl/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) | `<ravendb-node-url>/<database-name>/<etl-task-name>` |

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

<Admonition type="note" title="">
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.
</Admonition>



Expand Down
Loading