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.SQLExportMgr

%Library.SQLExportMgr

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

Export Controller for SQL Export.

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter RTNPREFIX = SQLExport;

Properties (Including Private)

property IsExporting as %Boolean [ InitialExpression = 0 ];
Private flag set to True when export is underway.
Property methods: IsExportingDisplayToLogical(), IsExportingGet(), IsExportingIsValid(), IsExportingLogicalToDisplay(), IsExportingNormalize(), IsExportingSet()

Methods (Including Private)

method CloseExport() as %Status
Call this at the end of the export operation.
method DeleteExportRoutine() as %Status
Delete the generated export routine.
method Export(savertn As %Boolean = 0)
Do an export from the command line.
method ExportRows(ByRef rows As %Integer, ByRef done As %Integer) as %Status
Exports the next rows rows to the export file. On return, rows contains the number of rows exported or 0 if the export is complete.
method GenDataExpr(col As %Integer, colno As %Integer) as %String
Compute and return the correct expression for column col.

colno is the number of the actual exported column (some columns may be skipped.

method GenerateExportRoutine(sample As %Integer = 0) as %Status
Generate the Export routine.

If sample is 1 then generate code that writes sample data to a local variable.

method GetExportSize(ByRef rows As %Integer) as %Status
Returns the number of rows in the export table in rows.

Call this after generating an export routine.

method GetSample(ByRef rows As %Integer) as %String
Exports the first rows rows to a sample variable.
method OpenExport() as %Status
Prepares the start of an export.

Call this after generating an export routine.

method Reset()
Reset the state of this object.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

FeedbackOpens in a new window