JDBCProviderManagement command group for AdminTask object

You can use the Jython or Jacl scripting languages in interactive mode to configure data access and data sources with scripting. The commands and parameters in the JDBCProviderManagement group can be used to create or list data sources and Java™ database connectivity (JDBC) providers.

The JDBCProviderManagement command group for the AdminTask object includes the following commands:

createDatasource

The createDatasource command creates a new data source to access the back end data store. Application components use the data source to access connection instances to your database.

Target object

JDBC Provider Object ID - The configuration object of the JDBC provider to which the new data source will belong.

Required parameters

- name
The name of the data source. (String, required)
-jndiName
The Java Naming and Directory Interface (JNDI) name. (String, required)
-dataStoreHelperClassName
The name of the DataStoreHelper implementation class that extends the capabilities of the selected JDBC driver implementation class to perform data-specific functions. WebSphere® Application Server provides a set of DataStoreHelper implementation classes for each of the JDBC provider drivers it supports. (String, required)
configureResourceProperties
This command step configures the resource properties that are required by the data source. (Required) You can specify the following parameters for this step:
name
The name of the resource property. (String, required)
type
The type of the resource property. (String, required)
value
The value of the resource property. (String, required)

Optional parameters

-description
The description of the data source. (String, optional)
-category
The category that you can use to classify a group of data sources. (String, optional)
-componentManagedAuthenticationAlias
The alias used for database authentication at run time. This alias is only used when the application resource reference is using res-auth=Application. (String, optional)
-containerManagedPersistence
Specifies if the data source is used for container managed persistence for enterprise beans. The default value is true. (Boolean, optional)

Examples

Batch mode example usage:

Interactive mode example usage:

Avoid trouble: Be aware of the following issues with the createDatasource command:
  • When you create a data source that supports container-managed persistence, the createDatasource command creates two objects in the configuration of the target scope: the intended data source and a CMP connector factory that is used expressly by the container. You must apply the remove command separately to the intended data source and the CMP connector factory objects in order to delete the data source from the configuration.
    The following script illustrates how to use Jacl to remove the CMPConnectorFactory object from the configuration when you delete a data source that supports container-managed persistence:
    # The following script removes a data source from the configuration,
    # including the associated CMP connector factory
    #
    # Set this variable to the ID string of the data source to remove
    set ds_to_remove "configID_of_my_data_source_to_remove"
    puts "Data source to remove='$ds_to_remove'"
    
    # Find and remove the CMPConectorFactory associated with the datasource to remove
    foreach cmp_cf [$AdminConfig list CMPConnectorFactory] {
      set cmp_ds [lindex [$AdminConfig showAttribute $cmp_cf cmpDatasource] 0]
      if { [string compare $cmp_ds $ds_to_remove] == 0 } {
        puts "Found CMPConnectorFactory for data source $ds_to_remove"
        puts "Removing the CMPConnectorFactory '$cmp_cf'"
        $AdminConfig remove $cmp_cf
        puts "'$cmp_cf' is removed."
        break
      }
    }
    
    puts "Removing the data source '$ds_to_remove'"
    $AdminConfig remove $ds_to_remove
    puts "'$ds_to_remove' is removed."
    
    #$AdminConfig save
  • The createDatasource command will not complete successfully if you are creating a data source on a JDBC provider that does not exist or does not contain the providerType attribute. This error can be caused if you created the JDBC provider with the AdminConfig create JDBCProvider method of the JMX API. This method creates the JDBC provider, but it does not add a providerType attribute.
    The createDatasource command will issue the following error:
    "ADMF0006E: Step configureResourceProperties of command createDatasource is not found"

    To resolve this issue, use commands from the JDBCProviderManagement group, which provides the AdminTask commands createJDBCProvider and createDatasource. The AdminTask commands are designed to be used together.

    The AdminConfig JMX API methods "create JDBCProvider" and "create Datasource," which support Version 5.1 and later, are also designed to be used together. Scripts that use the JMX API methods should not use the AdminTask commands.

  • The createDatasource command will not complete successfully if the JDBC provider object ID, which you specify when you create the data source, does not match the ID of the JDBC provider. If the JDBC provider object ID and the ID of the JDBC provider do not match, you can obtain the correct ID from the results of the createJDBCProvider command. Then, specify this ID when you use the createDatasource command. If you have already created the JDBC provider, use the listJDBCProviders command to list the correct ID.
gotcha

createJDBCProvider

The createJDBCProvider command creates a new Java database connectivity provider (JDBC) that you can use to connect to a relational database for data access.

Target object

None

Required parameters

-scope
The scope for the new JDBC provider. Provide the scope in the form type=name. Type can be Cell, Node, Server, Application, or Cluster, and name is the name of the specific instance of the cell, node, server, application, or cluster that you are using. The default is none. (String, required)
-databaseType
The type of database that will be used by the JDBC provider. For example, DB2, Derby, Informix®, Oracle, and so on. (String, required)
-providerType
The JDBC provider type that will be used by the JDBC provider. (String, required)
-implementationType
The implementation type for this JDBC provider. Use Connection pool data source if your application runs in a single phase or a local transaction. Otherwise, use XA data source to run in a global transaction. (String, required)

Optional parameters

-classpath
Specifies a list of paths or JAR file names that form the location for the resource provider classes. (String, optional)
-description
The description for the JDBC provider. (String, optional)
-implementationClassName
Specifies the Java class name for the JDBC driver implementation. (String, optional)
-name
The name of the JDBC provider. The default is the value from the provider template. (String, optional)
-nativePath
Specifies a list of paths that form the location for the resource provider native libraries. (String, optional)
-isolated
Specifies whether the JDBC provider loads within the class loader. The default value is false. You cannot specify a native path for an isolated JDBC provider. (Boolean, optional)

Examples

Batch mode example usage:

Interactive mode example usage:

listDatasources

Use the listDatasources command to list data sources that are contained in the specified scope.

Target object

None

Required parameters

None.

Optional parameters

-scope
The scope for the data sources that will be listed. Provide the scope in the form type=name. Type can be Cell, Node, Server, Application, or Cluster, and name is the name of the specific instance of the cell, node, server, application, or cluster that you are using. The default is All. (String, optional)

Examples

Batch mode example usage:

Interactive mode example usage:

listJDBCProviders

The listJDBCProviders command lists JDBC providers that are contained in the specified scope.

Target object

None

Required parameters

None.

Optional parameters

-scope
The scope for the JDBC providers that will be listed. Provide the scope in the form type=name. Type can be Cell, Node, Server, Application, or Cluster, and name is the name of the specific instance of the cell, node, server, application, or cluster that you are using. The default is All. (String, optional)

Examples

Batch mode example usage:

Interactive mode example usage:




Related tasks
Using the wsadmin scripting AdminTask object for scripted administration
Related reference
Commands for the AdminTask object using wsadmin scripting
Reference topic    

Terms of Use | Feedback

Last updated: Oct 21, 2010 1:44:59 AM CDT
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=compass&product=was-express-dist&topic=rxml_atjdbcprovider
File name: rxml_atjdbcprovider.html