Skip to main content


class %SQL.Import.Mgr extends %Library.RegisteredObject, %SQL.ExImData

Import Controller for SQL Import.

Property Inventory

Method Inventory


parameter RTNPREFIX = SQLImport;


property DeferIndices as %Integer [ InitialExpression = 1 ];
If true, generate indices after importing data using %SortBegin/%SortEnd.
Property methods: DeferIndicesDisplayToLogical(), DeferIndicesGet(), DeferIndicesIsValid(), DeferIndicesLogicalToDisplay(), DeferIndicesNormalize(), DeferIndicesSet()
property UseTransaction as %Integer [ InitialExpression = 0 ];
If true, nest the entire import operation in a transaction.


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


method AllocateRoutine(ByRef rtn As %String) as %Status
Return the name of the routine to use for the import
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) as %Status
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, total 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

Inherited Methods

FeedbackOpens in a new tab