spotf stream egress-route create-or-update sql
Create/Update SQL Egress Route
Arguments
None.
Options
--stream-group-name
: Stream Group name
- Required.
- Value = [string]
--stream-name
: Stream name
- Required.
- Value = [string]
--egress-route-name
: Egress Route name
- Required.
- Value = [string]
--config
: Egress Mapping in JSON format. (Egress mapping maps incoming messages from devices to SQL relations/rows.)
- Value = [string]
--config-path
: File path to Egress Mapping in a JSON document file. (Egress mapping maps incoming messages from devices to SQL relations/rows.)
- Value = [FileInfo]
--egress-sink-name
: Egress Sink name. (Must be provided for a new Egress Route.)
- Value = [string]
--notification-input
: Notification input type. (Message notifications - Contains payload and metadata of individual messages. Batch completion notification - Contains a link to the blob prefix in the stream storage where all messages from the batch are stored.)
- Value = [Messages|BatchCompletions]
--is-enabled
: Specifies whether to enable or disable the routing of notifications to the Egress Sink. By default, the routing of notifications to the Egress Sink is enabled when creating a new Egress Route.To disable it, use the option '--is-enabled false'.
--with-filter
: Specifies the condition to filter notifications sent to the Egress Sink. For example, by enabling the next condition 'starts_with(metadata.deviceId, 'test_') OR metadata.deviceId = 'my_awesome_device'', the platform will send to Egress Sink only those notifications, which coming from devices with IDs like 'test_device_1', 'my_awesome_device' etc. By default, the filtering is disabled for new routes. To disable already enabled one, use the option '--without-filter'.
- Value = [string]
--without-filter
: Do not use filtering.
--instance-label
: Label for IoT Platform instance
- Value = [string]
--workspace
: Workspace ID / Name
- Value = [string]