Note: this is an abstract component that cannot be instantiated.
An JDBC Sync Destination defines the destination of a Sync Pipe that is a relational database accessible via JDBC.
↓Direct Subcomponents
↓Parent Component
↓Relations To this Component
↓Properties
↓dsconfig Usage
The following JDBC Sync Destinations are available in the server :
These JDBC Sync Destinations inherit from the properties described below.
The JDBC Sync Destination component inherits from the Sync Destination
The following components have a direct aggregation relation from JDBC Sync Destinations:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ java-class | None |
| ↓ description | |
| ↓ server | |
| ↓ max-open-connections |
| Description | Specifies the fully-qualified name of the Java class that provides the Sync Destination implementation. |
| Default Value | None |
| Allowed Values | The fully-qualified name of a Java class that extends or implements com.unboundid.directory.sync.api.SyncDestination |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | A description for this Sync Destination |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the name of the JDBC External Server that should be used as the destination of synchronization. |
| Default Value | None |
| Allowed Values | The DN of any JDBC External Server. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The maximum number of connections that the JDBC Sync Destination is allowed to have open to the database at a given time. Care should be taken that the number of worker threads (specified by the num-worker-threads property on the Sync Pipe) does not exceed the number of available connections; otherwise thread starvation may occur. |
| Default Value | 30 |
| Allowed Values | An integer value. Lower limit is 1. Upper limit is 1000 . |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
To list the configured Sync Destinations:
dsconfig list-sync-destinations
[--property {propertyName}] ...
To view the configuration for an existing Sync Destination:
dsconfig get-sync-destination-prop
--destination-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Sync Destination:
dsconfig set-sync-destination-prop
--destination-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To delete an existing Sync Destination:
dsconfig delete-sync-destination
--destination-name {name}