This function creates a new data store, or adds to an existing data store, by importing records from the specified data source. It is assumed that the data source contains records exported from a data store using the function CSSM_DL_DbExport.

The DbDestinationName parameter specifies the name of a new or existing data store. If a new data store is being created, the DBInfo structure provides the meta-information (schema) for the new data store. This structure describes the record attributes and the index schema for the new data store. If the data store already exists, then the existing meta-information (schema) is used. (Dynamic schema evolution is not supported.)

Typically, user authentication is required to create a new data store or to write to an existing data store. An authentication credential is presented to the DL module in the form required by the module. (See the information provided with the DL module for information on the required form.) The resulting data store is not opened as a result of this operation.

CSSM_RETURN CSSMAPI CSSM_DL_DbImport
               (CSSM_DL_HANDLE DLHandle,
               const char *DbDestinationName,
               const char *DbSourceName,
               const CSSM_DBINFO_PTR DBInfo,
               CSSM_BOOL InfoOnly,
               const CSSM_USER_AUTHENTICATION_PTR UserAuthentication)

Input

DLHandle

The handle that describes the DL module to be used to perform this function.

DbDestinationName

The name of the destination data store into which the records will be inserted.

DbSourceName

The name of the data source from which to obtain the records that are added to the data store.

InfoOnly

A Boolean value indicating what to import. If CSSM_TRUE, import only the DBInfo, which describes the data store. If CSSM_FALSE, import both the DBInfo and all of the records exported from a data store.

Input/optional

DBInfo

A data structure containing a detailed description of the meta-information (schema) for the new data store. If a new data store is being created, then the caller must specify the meta-information (schema), or the data source must include the meta-information required for proper import of the records. If meta-information is supplied by the caller and specified in the data source, then the meta-information provided by the caller overrides the meta-information recorded in the data source.

If the data store exists and records are being added, then this pointer must be NULL. The existing meta-information will be used and the schema cannot be evolved.

UserAuthentication

The caller's credential as required for authorization to create a data store. If the DL module requires no additional credentials to create a new data store, then user authentication can be NULL.

A CSSM_OK return value signifies that the function completed successfully and the new data store was created. When CSSM_FAIL is returned, an error has occurred. Use CSSM_GetError to obtain the error code.

CSSM_DL_DbExport