"listDataChangeStreams" (JSON Action)
Return a list of data change streams that match all specified filters
The "listDataChangeStreams" action takes specified filter criteria and returns a filtered list of data change streams. Each stream includes its ID and description. Omit all filters to return a list of all streams.
This action ANDs together all the filter properties to create the filter. Omit a filter property or set it to null to prevent it from filtering the results. Omit all filters to return all data change streams.
When a filter property value is a string, the server treats it as a partial match of each character in the property's value to the corresponding character in the definitions. The server does not process characters as wildcards.
The "dataChangeStreamStatusFilter" property contains a list of status values that the server ORs together.
Request examples
Minimal
This example returns all data change streams.
{
"api": "admin",
"action": "listDataChangeStreams",
"params": {},
"authToken": "replaceWithAuthTokenFromCreateSession"
}
This example returns all data change streams that match the filter criteria.
{
"api": "admin",
"action": "listDataChangeStreams",
"params": {
"descriptionFilter": "existing & new",
"streamingConnectionNameFilter": "fmq",
"topicFilter": "cust",
"localDatabaseNameFilter": "ctr",
"localOwnerNameFilter": "admin",
"localTableNameFilter": "cust",
"localDataFilePathFilter": null,
"sourceDatabaseNameFilter": "ctr",
"sourceOwnerNameFilter": "admin",
"sourceTableNameFilter": "cust",
"sourceDataFilePathFilter": null,
"dataChangeStreamStatusFilter": [
"scheduled",
"jumpstarting",
"running",
"failed",
"initializing",
"pausing",
"paused",
],
"includeExistingRecordsFilter": true
},
"authToken": "replaceWithAuthTokenFromCreateSession"
}{
"authToken": "authToken",
"result": {
"dataChangeStreams": [
{
"id": 2,
"description": "existing & new CA records from db1 ctreesql_admin_custmast",
"dataChangeStreamStatus": "paused"
}
]
},
"errorCode": 0,
"errorMessage": ""
}
"params" property summariesProperty | Description | Default | Type | Limits (inclusive) | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
(optional) includes streams that match one of the included status values or all streams if no values are included. |
| array |
| ||||||||
(optional) specifies a partial match for a connection name. |
| string | 1 to 512 bytes | ||||||||
(optional) includes streams that synchronize existing records if true. |
| Boolean |
| ||||||||
(optional) specifies a partial match for the database name of the table on the FairCom MQ server that stores the stream's data change events. |
| string | 1 to 64 bytes | ||||||||
(optional) specifies a partial match for the file name of the table on the FairCom MQ server that stores the stream's data change events. |
| string | 1 to 64 bytes | ||||||||
(optional) specifies a partial match for the owner name of the table on the FairCom MQ server that stores the stream's data change events. |
| string | 1 to 64 bytes | ||||||||
(optional) specifies a partial match for the table name of the table on the FairCom MQ server that stores the stream's data change events. |
| string | 1 to 64 bytes | ||||||||
(optional) specifies a partial match for the database name of the table on the FairCom DB or RTG server that generates the stream's data change events. |
| string | 1 to 64 bytes | ||||||||
(optional) specifies a partial match for the file name of the table on the FairCom DB or RTG server that generates the stream's data change events. |
| string | 1 to 64 bytes | ||||||||
(optional) specifies a partial match for the owner name of the table on the FairCom DB or RTG server that generates the stream's data change events. |
| string | 1 to 64 bytes | ||||||||
(optional) specifies a partial match for the table name of the table on the FairCom DB or RTG server that generates the stream's data change events. |
| string | 1 to 64 bytes | ||||||||
(optional) specifies a partial match for a connection name. |
| string | 1 to 64 bytes | ||||||||
(optional) specifies a partial match for a stream's MQTT topic. |
| string | 1 to 65,535 bytes |
The "dataChangeStreamStatusFilter" is an optional array of strings that filters the results based on the change stream status. The response to this action will include streams that match one of the included status values or all streams if no values are included. You may specify any of the following statuses:
"scheduled" |
"jumpstarting" |
"running" |
"failed" |
"initializing" |
"pausing" |
"paused" |
The "descriptionFilter" property is an optional string that specifies a partial match for a connection name. The server will return all data change streams that have descriptions matching this property.
The "includeExistingRecordsFilter" property is a Boolean that returns streams that synchronize existing records if true.
The "localDatabaseNameFilter" property is an optional string that specifies a partial match for the database name of the table on the FairCom MQ server that stores the stream's data change events.
The "localDataFilePathFilter" property is an optional string that specifies a partial match for the file name of the table on the FairCom MQ server that stores the stream's data change events.
The "localOwnerNameFilter" property is an optional string that specifies a partial match for the owner name of the table on the FairCom MQ server that stores the stream's data change events.
The "localTableNameFilter" property is an optional string that specifies a partial match for the table name of the table on the FairCom MQ server that stores the stream's data change events.
The "sourceDatabaseNameFilter" property is an optional string that specifies a partial match for the database name of the table on the FairCom DB or RTG server that generates the stream's data change events.
The "sourceDataFilePathFilter" property is an optional string that specifies a partial match for the file name of the table on the FairCom DB or RTG server that generates the stream's data change events.
The "sourceOwnerNameFilter" property is an optional string that specifies a partial match for the owner name of the table on the FairCom DB or RTG server that generates the stream's data change events.
The "sourceTableNameFilter" property is an optional string that specifies a partial match for the table name of the table on the FairCom DB or RTG server that generates the stream's data change events.
The "streamingConnectionNameFilter" property is an optional string that specifies a partial match for a connection name.
The "topicFilter" property is an optional string that specifies a partial match for a stream's MQTT topic.
"result" property summariesProperty | Description | Type | Contents | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
lists the data change streams that match the filters in the request as separate objects. | array of objects | 0 or more objects | ||||||||||
| specifies the status of the data stream. | string enum |
| |||||||||
| specifies a user-defined description of the data change stream. It is not a unique identifier: the | string | 1 to 64 bytes | |||||||||
| specifies the unique data change stream identifier of the data change stream matching the request filters. | integer |
|
The "dataChangeStreams" property is an array of objects that lists the data change streams that match the request filters. Each data change stream that matches the filters specified in the request will be returned as its own separate object.
The "dataChangeStreamStatus" property specifies the status of the data change stream. It may specify any of the following states:
"failed" |
"initializing" |
"jumpstarting" |
"paused" |
"pausing" |
"running" |
"scheduled" |
The "description" property specifies a user-defined description of the data change stream. It is not a unique identifier: the "id" property returned by this action is the unique identifier.
The "id" property is an integer that specifies the unique data change stream identifier of the data change stream matching the request filters.