This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %Library.SQLImportMgr


class %Library.SQLImportMgr extends %Library.RegisteredObject, %Library.SQLExImData

Import Controller for SQL Import.

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter RTNPREFIX = SQLImport;

Properties (Including Private)

property DeferIndices as %Integer [ InitialExpression = 1 ];
If true, generate indices after importing data.
Property methods: DeferIndicesDisplayToLogical(), DeferIndicesGet(), DeferIndicesIsValid(), DeferIndicesLogicalToDisplay(), DeferIndicesNormalize(), DeferIndicesSet()
property IndexPending as %Integer [ Private , InitialExpression = 0 ];
If true, we still need to build indices.
Property methods: IndexPendingDisplayToLogical(), IndexPendingGet(), IndexPendingIsValid(), IndexPendingLogicalToDisplay(), IndexPendingNormalize(), IndexPendingSet()
property UseTransaction as %Integer [ InitialExpression = 0 ];
If true, nest the entire import operation in a transaction.


Property methods: UseTransactionDisplayToLogical(), UseTransactionGet(), UseTransactionIsValid(), UseTransactionLogicalToDisplay(), UseTransactionNormalize(), UseTransactionSet()

Methods (Including Private)

method BuildIndices() as %Status
Perform the merge sort to build the indices.
method CloseImport(abort As %Integer = 0) as %Status
Call this at the end of the import operation.
method DeleteImportRoutine() as %Status
Delete the generated import routine.
method ErrorCount() as %Integer
Returns the current number of import errors.
classmethod ErrorLogClose(QHandle As %Binary) as %Status
classmethod ErrorLogExecute(ByRef QHandle As %Binary) as %Status
classmethod ErrorLogFetch(ByRef QHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
method FileSize() as %Integer
Returns the size of the import file.
method GenerateImportRoutine() as %Status
Generate the Import routine.
method Import(savertn As %Boolean = 0)
Do an import from the command line.
method ImportRows(ByRef count As %Integer, ByRef inserted As %Integer, ByRef bytes As %Integer, ByRef done As %Integer, ByRef errorcount As %Integer) as %Status
Reads the next count rows from the import file.

On return, counts contains the number of rows read from the file. inserted contains the number of rows successfully inserted. bytes contains the number of bytes read from the file. done is set to one when the import is complete. errorcount is the cumulative number of INSERT errors encountered.

method OpenImport() as %Status
Prepares the start of an import.

Call this after generating an import routine.

method ReadHeader(ByRef header As %String, ByRef size As %Integer) as %Status
Reads the first line of the import file.
method Reset()
Reset the state of this object.


query ErrorLog()
Selects Type As %String, ErrorNo As %Integer, ErrorText As %String, Row As %Integer

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)