Field | Description |
---|---|
name | A string representing the name of the stream. |
action (optional) | Defines the action associated with the stream, e.g., “create”, “update”, or “delete”. |
json_schema | A hash representing the JSON schema of the stream. |
supported_sync_modes (optional) | An array of supported synchronization modes for the stream. |
source_defined_cursor (optional) | A boolean indicating whether the source has defined a cursor for the stream. |
default_cursor_field (optional) | An array of strings representing the default cursor field(s) for the stream. |
source_defined_primary_key (optional) | An array of arrays of strings representing the source-defined primary key(s) for the stream. |
namespace (optional) | A string representing the namespace of the stream. |
url (optional) | A string representing the URL of the API stream. |
request_method (optional) | A string representing the request method (e.g., “GET”, “POST”) for the API stream. |
batch_support | A boolean indicating whether the stream supports batching. |
batch_size | An integer representing the batch size for the stream. |
request_rate_limit | An integer value, specifying the maximum number of requests that can be made to the user data API within a given time limit unit. |
request_rate_limit_unit | A string value indicating the unit of time for the rate limit. |
request_rate_concurrency | An integer value which limits the number of concurrent requests. |
Field | Description |
---|---|
streams | An array of Streams detailing the data within the data store. This encapsulates various data streams available for synchronization or processing, each potentially with its own schema, sync modes, and other configurations. |
request_rate_limit | An integer value, specifying the maximum number of requests that can be made to the user data API within a given time limit unit. This serves to prevent overloading the system by limiting the rate at which requests can be made. |
request_rate_limit_unit | A string value indicating the unit of time for the rate limit, such as “minute” or “second”. This defines the time window in which the request_rate_limit applies. |
request_rate_concurrency | An integer value which limits the number of concurrent requests that can be made. This is used to control the load on the system by restricting how many requests can be processed at the same time. |
schema_mode | A string value that identifies the schema handling mode for the connector. Supported values include static, dynamic, and schemaless. This parameter is crucial for determining how the connector handles data schema. |
name
(optional): A string representing the name of the model.query
: A string representing the query used to extract data from the source.query_type
: A type representing the type of query used by the model.primary_key
: A string representing the primary key of the model.source
: The source connector from which data is transferred.destination
: The destination connector where data is transferred.model
: The model specifying the data to be transferred.stream
: The stream defining the structure and metadata of the data to be transferred.sync_mode
: The synchronization mode determining how data is transferred.cursor_field
(optional): The field used as a cursor for incremental data transfer.destination_sync_mode
: The synchronization mode at the destination.connector_spec() -> ConnectorSpecification
None
Output - ConnectorSpecification
-One of the main pieces of information the specification shares is what information is needed to configure an Actor.
documentation_url
:stream_type
:static
: The connector catalog is static.dynamic
: The connector catalog is dynamic, which can be either schemaless or with a schema.user_defined
: The connector catalog is defined by the user.connector_query_type
:raw_sql
: The connector is SQL-based.soql
: Specifically for Salesforce.ai_ml
: Specific for AI model source connectors.connection_specification
:sync_mode
:meta_data() -> Hash
None
Output - Hash
. Sample hash can be found here
check_connection(connection_config) -> ConnectionStatus
Hash
Output - ConnectionStatus
discover(connection_config) -> Catalog
Hash
Output - Catalog
read(SyncConfig) ->Array[RecordMessage]
write(SyncConfig,Array[records]) -> TrackingMessage
Array[Record]
Output - TrackingMessage
Note: Complete multiwoven protocol models can be found here