Class %Stream.GlobalCharacter

stream class %Stream.GlobalCharacter extends TmpCharacter

For information on this class, see Working with Streams.

Stream class that stores character data in global nodes.

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
1		8

Summary

Properties
%Location	AtEnd	Id	LastModified	LineTerminator
RemoveOnClose	Size

Methods
%AddToSaveSet	%CheckUnique	%ClassIsLatestVersion	%ClassName
%ConstructClone	%Delete	%DeleteExtent	%DeleteId
%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty	%DispatchMethod
%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty	%Exists
%ExistsId	%Extends	%GetParameter	%GetSwizzleObject
%Id	%IsA	%IsModified	%IsNull
%KillExtent	%LOBPrefetch	%LocationSet	%LockStream
%New	%NormalizeObject	%ObjectIsNull	%ObjectModified
%ObjectSize	%Oid	%Open	%OpenId
%OriginalNamespace	%PackageName	%ReleaseLock	%Reload
%RemoveFromSaveSet	%RollBack	%Save	%SerializeObject
%SetModified	%UnlockStream	%ValidateObject	Clear
CopyFrom	CopyFromAndSave	FindAt	Flush
GetStreamId	InputFromDevice	IsCharacter	IsNull
LastModifiedGet	MoveTo	MoveToEnd	OutputToDevice
OutputToDeviceAt	Read	ReadLine	ReadLineIntoStream
ReadSQL	Rewind	SerializeToSyncSet	SizeGet
StreamOIDIsNull	SyncStreamIn	Write	WriteLine

Subclasses
%Stream.GblChrCompress	%Stream.GlobalBinary	%Stream.GlobalCharacterSearchable
%Stream.MethodGenerator

Parameters

• parameter COMPRESS = 1;

Compress behavior of this class.

-1 - Do not compress streams, write old stream header format

0 - Do not compress new streams

1 - Compress new streams

2 - Always compress

Methods

• method CopyFromAndSave(source As %Stream.Object) as %Status

Copy the stream from source into the current stream ignoring anything already in the current stream and save the result to the permanent location. This is used to optimise the copying of say a %GlobalCharacterStream to another %GlobalCharacterStream to avoid copying into temporary storage first and then moving this to the permanent storage when SaveStream is called.
Note that any locking or transaction handling must be done by the caller.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search