Attributes

Returns an object representing a collection of attributes in the entity.

 BoundAttachments

Get all the BoundAttachments of this Entity.

 BoundSecurityProperties

Get all the BoundSecurityProperties of this Entity.

 ChildRelationships

Returns an object representing a collection of child relationships for the entity.

 DataMovementRuleLinks

Get all the DataMovementRules bound to this Entity.

 DB2OS390TablePartitions

Returns the collection of DB2 OS/390 table partitions. Also manages the partition key.

 DB2UDBDimensions

Returns a collection of DB2 UDB v9.x dimensions.

 DB2UDBTableRangePartitions

Returns the collection of DB2 UDB v9.x table range partitions. Also manages the partition key.

 DeleteNamingStandardsTemplate

Unbind this Entity from the naming standards template by deleting the naming standards template ID from the entity.

 GetNamingStandardsTemplate

Returns the naming standards template bound to the entity or null, if none is bound to the entity.

 HiveStoredAsInputOutputHandlers

Use to set INPUTFORMAT and OUTPUTFORMAT handler class names for the STORED AS clause of the Create Table statement. Either strings must be empty or both strings must contain a handler name.

 Indexes

Returns an object representing a collection of indexes in the entity.

 ObjectPermissions

Returns the collection of Object Permissions for this object.

 OracleTablePartitions

Returns the collection of oracle table partitions. Also manages the partition key and subpartition key and table level subpartitions.

 ParentRelationships

Returns an object representing a collection of parent relationships for the entity.

 RepoCheckOutStatus

Get the Check Out status of this Entity object. DATATYPE: StringObjects.

 RepoVersionHistory

Get the Version History of this Entity from the Repository server. Return the data in the StringObjects collection. DATATYPE: StringObjects.

 TableCheckConstraints

Returns an object representing a collection of Table Level Check Constraints in the entity.

 Triggers

Returns an object representing a collection of triggers in the entity.

 UniversalMappings

Returns a collection of universal mappings applied to this object.

 UserComments

Returns a collection of user comments associated with the entity.

 UserDefinedMappings

Returns a collection of user defined mappings applied to this object.

 WhereUsedModelUsage

Returns a collection of matches in other models based on the results of a WhereUsed analysis on this object.

 WhereUsedSubmodelUsage

Returns a collection based on the results of a WhereUsed analysis of SubModels in the current model that contain this object.

 AverageRowSize

This is the read-only AverageRowSize property of the table. It applies only to Oracle 10 g and higher versions of Oracle platforms.

 ClusterByColumns

Google BigQuery, Hive, and Snowflake only. This property holds the comma separated list of Clustered By columns. DATATYPE: String.

 Compress

This is the Compress property of the table. DATATYPE: Boolean.

 CompressExpression

This property holds the table compress expression for the table. It only applies to Oracle 9 and older versions. DATATYPE: String.

 DatabaseLocation

This is the Database location of the entity. The input string should not include dots. Dots will be removed. DATATYPE: String.

 DB2Auditing

This is the Table Storage Auditing option. The only valid strings are NONE, CHANGES, and ALL. DATATYPE: String.

 DB2DataCaptureChg

This is the Table Storage Log Data Changes value. DATATYPE: Boolean.

 DB2EditProc

This is the Table Storage Edit Proc value. DATATYPE: String.

 DB2Encoding

This is the Table Storage Encoding option. Valid string values are only ASCII, EBCDIC, and NONE. DATATYPE: String.

 DB2InDatabase

This indicates if the Table Storage is In Database. DATATYPE: Boolean.

 DB2OSVolatile

This specifies if a table is volatile and it applies only to DB2 OS/390 V8 or later versions. DATATYPE: Boolean.

 DB2RestrictOnDrop

This is the Table Storage Restrict On Drop value. DATATYPE: Boolean.

 DB2ValidProc

This is the Table Storage Valid Proc value.DATATYPE: String.

 Definition

This is the definition of the entity. DATATYPE: String.

 DimensionTableType

This is the Dimension Table Type. The possible values are FIXED, TYPE1, TYPE2 or TYPE3. DATATYPE: String.

 DimModelTableType

This is the Dimensional Model Table Type. The possible values are DIMENSION, FACT, SNOWFLAKE or UNDEFINED. DATATYPE: String.

 DimModelTableTypeOverride

This sets the Dimensional Model Table Type Override on or off. The possible values are true or false. DATATYPE: Boolean.

 DoNotGenerate

If true, the Table will not be generated in the DDL. DATATYPE: Boolean.

 EntityName

This is the name of the entity in the logical model. DATATYPE: String.

 FreeListGroups

This is the FreeListGroups of the entity storage. DATATYPE: Integer.

 FreeLists

This is the FreeLists of the entity storage. DATATYPE: Integer.

 FreezeName

True if this entity should not be affected by naming standards name updates. DATATYPE: Boolean.

 GenPostSQL

This is the Generate PostSQL option of the entity. DATATYPE: Boolean.

 GenPreSQL

This is the Generate PreSQL option of the entity. DATATYPE: Boolean.

 GoogleBigqueryExpirationTimestamp

This is the date and time a Google BigQuery table is deleted along with all of the data contained within that table. DATATYPE: String.

 GoogleBigqueryKmsKeyName

This is the name of the key used to encrypt your encryption keys as part of the Google BigQuery Cloud Key Management Service (KMS). DATATYPE: String.

 GoogleBigqueryLabels

This is the name of a Google BigQuery label that you can apply to your resources, such as your datasets, tables, and views. DATATYPE: String.

 GoogleBigqueryPartitionExpirationTimestamp

This is the date and time Google BigQuery partitions in a table are deleted along with all of the data contained within each partition. This expiration is calculated independently for each partition based on partition time. DATATYPE: Integer.

 GoogleBigqueryPartitionBy

This is the time period by which Google BigQuery tables are partitioned. DATATYPE: String.

 GoogleBigqueryPartitionFilter

Y equals Boolean True if all queries for this table require a partition filter. DATATYPE: String.

 GoogleBigqueryPartitionType

This is the type of partitioning used to partition Google BigQuery tables. DATATYPE: String.

 GoogleBigqueryRangeFields

This is the range used to partition Google BigQuery tables. DATATYPE: String.

 GreenplumDistributionColumns

This is the GreenplumDistributionColumns property of the table. It applies only to Greenplum. DATATYPE: String.

 GreenplumDistributionRandom

This is the GreenplumDistributionRandom property of the table. It applies only to Greenplum. DATATYPE: Boolean.

 GrowthPeriod

This is the period the growth rate is based on. The value of this property can be one of these: Day, Week, Month, Quarter or Year. This property applies only to physical models. DATATYPE: String.

 GrowthRate

This determines how fast a table will grow. This property applies only to physical models. DATATYPE: Integer.

 GrowthType

This is the the type the growth rate is based on. The value of this property can be either Percent or Rows. This property applies only to physical models. DATATYPE: String.

 GUID

GUID of the entity. This GUID is assigned by ER/Studio. Each entity has a unique GUID. DATATYPE: String.

 HiRDBFix

This is the Fix option of the entity storage. DATATYPE: Boolean.

 HiRDBRowLock

This is the Row Lock option of the entity storage. DATATYPE: Boolean.

 HiRDBStorageIn

This is the Storage In option of the entity storage. DATATYPE: Boolean.

 HiveAsSelect

Hive only. This property holds AsSelect value for the table. DATATYPE: String.

 HiveClusteredByColumns

Hive only. This property holds the comma separated list of Clustered By columns. DATATYPE: String.

 HiveExternalTable

This is the External property of the table. If true, the table with be created extenally: CREATE EXTERNAL TABLE ... It applies only to Hive models. DATATYPE: Boolean.

 HiveLocation

This property determines where the table will be stored in the HDFS. It applies only to Hive models. DATATYPE: String.

 HiveNumBuckets

Hive only. This property NUM_BUCKETS value for the table. DATATYPE: Integer.

 HiveRowFormatCollections

This property corresponds to COLLECTION ITEMS TERMINATED BY of the ROW FORMAT clause in the create table statement. It requires HiveRowFormatDelimited to be true. It applies only to Hive models. DATATYPE: String.

 HiveRowFormatDelimited

This Hive only property pertains to the RowFormat of the table. If true, the table will be created with ROW FORMAT DELIMITED. Cannot be set to true if a RowFormat SerDe has been specified (via HiveStoredBySerDeHandler). DATATYPE: Boolean.

 HiveRowFormatEscapedBy

This Hive only property corresponds to ESCAPED BY part of the FIELDS TERMINATED BY clause in the create table statement. It requires HiveRowFormatFields to be set. DATATYPE: String.

 HiveRowFormatFields

This property corresponds to FIELDS TERMINATED BY of the ROW FORMAT clause in the create table statement. It requires HiveRowFormatDelimited to be true. It applies only to Hive models. DATATYPE: String.

 HiveRowFormatLines

This property corresponds to LINES TERMINATED BY of the ROW FORMAT clause in the create table statement. It requires HiveRowFormatDelimited to be true. It applies only to Hive models. DATATYPE: String.

 HiveRowFormatMapKeys

This property corresponds to MAP KEYS TERMINATED BY of the ROW FORMAT clause in the create table statement. It requires HiveRowFormatDelimited to be true. It applies only to Hive models. DATATYPE: String.

 HiveRowFormatNullDefinedBy

This Hive only property corresponds to NULL DEFINED AS of the ROW FORMAT clause in the create table statement. It requires HiveRowFormatDelimited to be true. (Available on DBServers starting with Hive 0.13). DATATYPE: String.

 HiveRowFormatSerDeHandler

This property is the name of the SerDe handler for ROW FORMAT. It requires HiveRowFormatDelimited to be false. It applies only to Hive models. DATATYPE: String.

 HiveRowFormatSerDeProperties

This property holds the comma separated properties for ROW FORMAT SerDe. It requires HiveRowFormatSerDeHandler to be set. It applies only to Hive models. DATATYPE: String.

 HiveSkewedByColumns

Hive only. This property holds the comma separated list of Skewed By columns. DATATYPE: String.

 HiveSkewedByValues

Hive only. This property holds the Skewed On Values for the table. DATATYPE: String.

 HiveSortedByColumns

Hive only. This property holds the comma separated list of Sorted By columns. DATATYPE: String.

 HiveStoredAs

Hive only. Is file format in the STORED AS clause. Valid input: , BINARYFILE, ORC, RCFILE, SEQUENCEFILE, TEXTFILE. Output also includes InputOutput Handler clause. HiveStoredBySerDeHandler must be empty. DATATYPE: String.

 HiveStoredAsByNumber

Same as HiveStoredAs, but enumerates the file format as follows: 0:not set, 1:BINARYFILE, 2:INPUT FORMAT OUTPUT FORMAT , 3:ORC, 4:RCFILE, 5:SEQUENCEFILE, 6:TEXTFILE. 2 is output only. DATATYPE: Integer.

 HiveStoredAsInputHandler

Hive only. Read only. This is the INPUTFORMAT handler name of the STORED AS clause. Of the INPUTFORMAT handler.class.name string it returns the handler.class.name part. HiveStoredBySerDeHandler must be empty. DATATYPE: String.

 HiveStoredAsOutputHandler

Hive only. Read only. This is the OUTPUTFORMAT handler name of the STORED AS clause. Of the OUTPUTFORMAT handler.class.name string it returns the handler.class.name part. HiveStoredBySerDeHandler must be empty. DATATYPE: String.

 HiveStoredBySerDeHandler

This Hive only property is the name of the SerDe handler that would appear in the STORED BY clause of the Create Table statement. It requires HiveStoredAs to be empty. DATATYPE: String.

 HiveStoredBySerDeProperties

This Hive only property holds the comma separated properties for STORED BY SerDe. It requires HiveStoredBySerDeHandler to be set. DATATYPE: String.

 HiveTblProperties

Hive only. This property holds the TblProperties value for the table. DATATYPE: String.

 ID

ID of the entity. This ID is assigned by ER/Studio. Each entity in a diagram has a unique ID. DATATYPE: Integer.

 IndexTablespace

This property specifies the Tablespace in which the Index for this table will be created. DATATYPE: String.

 InformixLockMode

This is the InformixLockMode property of the table. It applies to Informix Online and Informix 9.x or later versions. DATATYPE: Integer. Possible values: 0 for PAGE and 1 for ROW.

 InitialExtent

This is the initial extent of the entity storage. DATATYPE: Integer.

 InitTransactions

This is the Initial Transactions of the entity storage. DATATYPE: Integer.

 InterModelID

InterModelID of the object. This ID is assigned by ER/Studio. DATATYPE: Integer.

 IsStatic

This determines if a table is a static table or it will grow. This property applies only to physical models. DATATYPE: Boolean.

 LastSourced

This property is for DataLineage and applies only if the parent model is physical and has been enabled for data movement. This property tells when the data was last sourced. DATATYPE: String.

 LogForReplication

Specifies that the table's data are physically replicated on each partition on which the table is defined. DATATYPE: Boolean.

 LogOrPhysOnly

Controls the logical/physical only Entity Property. DATATYPE: Boolean.

 LongTablespace

This property identifies the Tablespace in which the values of any long columns will be stored. DATATYPE: String.

 MaxExtents

This is the MaxExtents of the entity storage. Parameter can be positive integer as string or UNLIMITED. DATATYPE: String.

 MaximumRows

This is the maximum number of rows a table can hold. This property applies only to physical models. DATATYPE: Integer.

 MaxTransactions

This is the MaxTransactions of the entity storage. DATATYPE: Integer.

 MinExtents

This is the MinExtents of the entity storage. DATATYPE: Integer.

 MySQLTableType

This is the type of the table for MySQL model. The possible values are MYISAM or INNODB. DATATYPE: String.

 NamingStandardsTemplateId

ID of the NamingStandardsTemplate object bound to the entity (if any). A user can bind a NamingStandardsTemplate to the entity by assigning a particular NamingStandardsTemplateId to this property. DATATYPE: Integer.

 NetezzaDistributionColumns

This is the NetezzaDistributionColumns property of the table. It applies only to Netezza 4.6, 5.0 and later versions. DATATYPE: String.

 NetezzaDistributionRandom

This is the NetezzaDistributionRandom property of the table. It applies only to Netezza 4.6, 5.0 and later versions. DATATYPE: Boolean.

 NetezzaOrganizationColumns

This is the Organization Key property of the table and contains up to four comma separated columns. It applies to Netezza 6.0 or later. DATATYPE: String.

 NextExtent

This is the next extent of the entity storage. DATATYPE: Integer.

 NoLogging

This determines whether there is no logging (true) or logging (false) in the entity storage. DATATYPE: Boolean.

 Note

This is the note of the entity. DATATYPE: String.

 OracleAccessDriver

This is used to set/unset the Oracle External Table Access Driver property. It can be set only if the OracleExternalTables property is TRUE.

 OracleAccessParameters

This is used to set/unset the Oracle External Table Access Parameters property. It can be set only if the OracleExternalTables property is TRUE.

 OracleBufferPool

This is the BufferPool of the entity storage. Values can be KEEP, RECYCLE, DEFAULT or NONE. DATATYPE: String.

 OracleCache

This is the Cache property of the entity storage. Must be heap organized. True for Cache on, false for Cache off. DATATYPE: Boolean.

 OracleDefaultDirectory

This is used to set/unset the Oracle External Table Default Directory property. It can be set only if the OracleExternalTables property is TRUE.

 OracleExternalTables

This is used to set/unset the Oracle External Table property.

 OracleExtLocation

This is used to set/unset the Oracle External Table Location property. It can be set only if the OracleExternalTables property is TRUE.

 OracleDegrees

This is the Degrees property of the entity storage. Degrees is only valid if parallel is true. DATATYPE: String.

 OracleIndex

This is the Index property of the entity storage. It is true if index organized, false if heap organized. DATATYPE: Boolean.

 OracleInstances

This is the Indexes property of the entity storage. Instances is only valid if parallel is true. DATATYPE: String.

 OracleParallel

This is the Parallel option of the entity storage. DATATYPE: Boolean.

 OracleRowMovement

This is the OracleRowMovement property of the table. It applies only to Oracle 9 and later versions, and it is not supported for non-partitioned index-organized tables. DATATYPE: Boolean.

 Owner

This is the owner of the entity. DATATYPE: String.

 PctFree

This is the percent free of the entity storage. DATATYPE: Integer.

 PctIncrease

This is the percent increase of the entity storage. DATATYPE: Integer.

 PctUsed

This is the percent used by the entity storage. DATATYPE: Integer.

 Persistence

Snowflake only. This property holds the persistence type for a Snowflake table. Possible values returned are TRANSIENT, VOLATILE, GLOBAL, LOCAL, TEMPORARY, PERMANENT.

 PostSQL

This is the PostSQL of the entity. DATATYPE: String.

 PreSQL

This is the PreSQL of the entity. DATATYPE: String.

 RowCount

This is the current number of rows in a table. This property applies only to physical models. DATATYPE: Integer.

 SourcingFrequency

This property is for DataLineage and applies only if the parent model is physical and has been enabled for data movement. This property tells how often the data is sourced. DATATYPE: String.

 StorageLocation

This is the storage location of the entity. DATATYPE: String.

 SybaseIdentityGap

This is the Identity Gap option of the entity storage. It must be a positive integer (in kilobytes). DATATYPE: Integer.

 SybaseLockingScheme

This is the Locking Scheme option of the entity storage. The possible values are ALLPAGES, DATAPAGES or DATAROWS. DATATYPE: String.

 SybaseMaxRowsPerPage

This is the Max Rows Per Page option of the sybase table storage. DATATYPE: Integer.

 SybasePrefetchStrategyOn

This is the Prefetch Strategy option of the entity storage. If it is true then the prefetch strategy is on, if it is false then it is off. DATATYPE: Boolean.

 SybaseReplacementStrategyMRU

This is the Replacement Strategy option of the entity storage. If it is true then the MRU replacement strategy is use, if it is false then LRU is used. DATATYPE: Boolean.

 SybaseReservePageGap

This is the Reserve Page Gap option of the entity storage. It must be a positive integer (in kilobytes). DATATYPE: Integer.

 SystemName

This is the system name of the AS400 table. DATATYPE: String.

 TableDDL

This is the TableDDL of the entity. DATATYPE: String.

 TableName

This is the name of the table in a physical model. DATATYPE: String.

 TeradataAfterJournal

This is the After Journal option of the entity storage. The possible values are – --, NO, DUAL, LOCAL, NOT LOCAL or the empty string (meaning nothing has been specified). DATATYPE: String.

 TeradataBeforeJournal

This is the Before Journal option of the entity storage. The possible values are – --, NO, DUAL or the empty string (meaning nothing has been specified). DATATYPE: String.

 TeradataChecksum

This is the TeradataChecksum property of the table. It applies to Teradata 12 or later versions. DATATYPE: String. Possible values: Default,All,High,Medium,Low,None, or empty(no DDL output)

 TeradataDatablockSize

This is the Datablock Size option of the entity storage. It can be a positive integer (in kilobytes) or the string MINIMUM or MAXIMUM. DATATYPE: Integer or String.

 TeradataDuplicateRowControl

This is the DuplicateRowControl option of the entity storage. The possible values are SET, MULTISET or the empty string (meaning nothing has been specified). DATATYPE: String.

 TeradataFallback

This is the Fallback protection option of the entity storage. If it is true then Fallback protection is used for the table. DATATYPE: Boolean.

 TeradataJournalName

This is the Journal Name option of the entity storage. If the entity has a Journal Table, then the name of the table is stored here. DATATYPE: String.

 TextImageFileGroup

This property specifies the table space in which the text/image columns are stored for the table. DATATYPE: String.

 TextLabel

This is the text label of the AS400 table. DATATYPE: String.