Class Reference
IRIS for UNIX 2024.1.2
 InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [INFORMATION] >  [SCHEMA] >  [USERDEFINEDAGGREGATES]
Private  Storage   

persistent class INFORMATION.SCHEMA.USERDEFINEDAGGREGATES extends %Library.Persistent

SQL Table Name: USER_DEFINED_AGGREGATES

Returns one row for each user defined aggregate that can be accessed by the current user in the current namespace.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 11


Summary

Properties
AGGREGATECHEMA AGGREGATENAME FINALIZEFUNCTION INITIALIZEFUNCTION
ITERATEFUNCTION MERGEFUNCTION OWNER PARAMETERLIST
RETURNTYPE

Methods
%AddToSaveSet %AddToSyncSet %BuildDeferredIndices %BuildIndicesAsync
%BuildIndicesAsyncResponse %CheckConstraints %CheckConstraintsForExtent %ClassIsLatestVersion
%ClassName %ComposeOid %ConstructClone %Delete
%DeleteExtent %DeleteId %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %Exists %ExistsId %Extends
%GUID %GUIDSet %GetLock %GetParameter
%GetSwizzleObject %Id %IsA %IsModified
%IsNull %KillExtent %LockExtent %LockId
%New %NormalizeObject %ObjectIsNull %ObjectModified
%Oid %OnBeforeAddToSync %OnDeleteFinally %OnDetermineClass
%OnOpenFinally %OnSaveFinally %Open %OpenId
%OriginalNamespace %PackageName %PurgeIndices %Reload
%RemoveFromSaveSet %ResolveConcurrencyConflict %RollBack %Save
%SaveDirect %SerializeObject %SetModified %SortBegin
%SortEnd %SyncObjectIn %SyncTransport %UnlockExtent
%UnlockId %ValidateIndices %ValidateObject %ValidateTable


Parameters

• parameter READONLY = 1;
READONLY = 1 means that objects can be created, opened but not saved or deleted. Tables are projected to SQL as READONLY.

Properties

• property AGGREGATECHEMA as %String(COLLATION="Upper",MAXLEN=128) [ SqlFieldName = AGGREGATE_SCHEMA,Required ];
Name of the schema that contains the user defined aggregate
• property AGGREGATENAME as %String(COLLATION="Upper",MAXLEN=128) [ SqlFieldName = AGGREGATE_NAME,Required ];
Aggregate name
• property FINALIZEFUNCTION as %String(MAXLEN=257) [ SqlFieldName = FINALIZE_FUNCTION ];
The Finalize Function of the User Defined Aggregate
• property INITIALIZEFUNCTION as %String(MAXLEN=257) [ SqlFieldName = INITIALIZE_FUNCTION ];
The Initialize Function of the User Defined Aggregate
• property ITERATEFUNCTION as %String(MAXLEN=257) [ SqlFieldName = ITERATE_FUNCTION ];
The Iterate Function of the User Defined Aggregate
• property MERGEFUNCTION as %String(MAXLEN=257) [ SqlFieldName = MERGE_FUNCTION ];
The Merge Function of the User Defined Aggregate
• property OWNER as %String(MAXLEN=160) [ SqlFieldName = OWNER ];
The owner of the User Defined Aggregate
• property PARAMETERLIST as %String(MAXLEN=512) [ SqlFieldName = PARAMETER_LIST ];
The parameters and types of the User Defined Aggregate
• property RETURNTYPE as %String(MAXLEN=128) [ SqlFieldName = RETURN_TYPE ];
The datatype of the value returned by the User Defined Aggregate

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