Class Reference
IRIS for UNIX 2024.1.2
 InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%Library] >  [SQLExportMgr]
Private  Storage   

class %Library.SQLExportMgr extends %RegisteredObject, %SQLExImData

Export Controller for SQL Export.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 1 10


Summary

Properties
ClassName ColumnNames ColumnTypes ColumnWidths DateFormat
Delimiter FileName HasHeaders IsExporting NoCheck
StringQuote TableName

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
CloseExport DeleteExportRoutine Export ExportRows
GenDataExpr GenerateExportRoutine GetExportSize GetSample
OpenExport Reset ResetExImData


Parameters

• parameter RTNPREFIX = "SQLExport";

Properties

• property IsExporting as %Boolean [ InitialExpression = 0 ];
Private flag set to True when export is underway.

Methods

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

Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.