read_connections
Manage and verify data source connections in CData Sync. List available connections, retrieve specific details, or test connectivity to ensure proper configuration before running synchronization jobs.
Instructions
Access data source/destination connections that define how CData Sync connects to databases, APIs, and files. If not authenticated with CData Sync, you will be prompted for credentials. Use 'list' to see all available connections, 'get' to retrieve details about a specific connection, 'test' to verify credentials and connectivity. Connections must be created and tested before being used in jobs. Multiple jobs can use the same connection simultaneously. Note: For counting connections, use 'list' and count the results client-side.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| action | No | Operation to perform. Use 'list' to see all connections, 'get' for specific connection details, 'test' to verify connectivity. For counts, use 'list' and count results. | list |
| name | No | Connection name (required for 'get' and 'test' actions). Case-sensitive. | |
| providerName | No | Provider name for 'test' action (optional - uses existing if not specified) | |
| filter | No | OData filter expression. SUPPORTED: eq, ne, gt, lt, ge, le, and, or LIMITED SUPPORT: contains(), startswith() NOT SUPPORTED: nested queries, computed properties Example: "ProviderName eq 'CData Salesforce' and ConnectionState eq 'Successful'" | |
| select | No | Comma-separated properties to include in results (e.g., 'Name,ProviderName,ConnectionState') | |
| top | No | Maximum number of results to return (for pagination) | |
| skip | No | Number of results to skip (for pagination) | |
| verbosity | No | Log detail level for 'test' action: 1=Error, 2=Info, 3=Transfer, 4=Verbose | |
| workspaceId | No | Workspace ID to use for this operation. Overrides the default workspace. Use 'default' for the default workspace or a UUID for specific workspaces. |