Public Methods
| Method | Description |
|---|---|
| Attributes | Returns an object representing a collection of attributes in the entity. |
Get all the BoundAttachments of this Entity. | |
Get all the BoundSecurityProperties of this Entity. | |
Returns an object representing a collection of child relationships for the entity. | |
Get all the DataMovementRules bound to this Entity. | |
Returns the collection of DB2 OS/390 table partitions. Also manages the partition key. | |
Returns a collection of DB2 UDB v9.x dimensions. | |
Returns the collection of DB2 UDB v9.x table range partitions. Also manages the partition key. | |
Unbind this Entity from the naming standards template by deleting the naming standards template ID from the entity. | |
Returns the naming standards template bound to the entity or null, if none is bound to the entity. | |
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. | |
Returns an object representing a collection of indexes in the entity. | |
Returns the collection of Object Permissions for this object. | |
Returns the collection of oracle table partitions. Also manages the partition key and subpartition key and table level subpartitions. | |
Returns an object representing a collection of parent relationships for the entity. | |
Get the Check Out status of this Entity object. DATATYPE: StringObjects. | |
Get the Version History of this Entity from the Repository server. Return the data in the StringObjects collection. DATATYPE: StringObjects. | |
Returns an object representing a collection of Table Level Check Constraints in the entity. | |
Returns an object representing a collection of triggers in the entity. | |
Returns a collection of universal mappings applied to this object. | |
Returns a collection of user comments associated with the entity. | |
Returns a collection of user defined mappings applied to this object. | |
Returns a collection of matches in other models based on the results of a WhereUsed analysis on this object. | |
Returns a collection based on the results of a WhereUsed analysis of SubModels in the current model that contain this object. |
Public Properties
| Method | Description |
|---|---|
Oracle 10g and later only. Read-only AverageRowSize property of the table. | |
Google BigQuery, Hive, and Snowflake only. Holds the comma-separated list of Clustered By columns. DATATYPE: String. | |
Compress property of the table. DATATYPE: Boolean. | |
Oracle 9 and later only. Holds the table compress expression for the table. DATATYPE: String. | |
Database location of the entity. The input string cannot include dots or they are removed. DATATYPE: String. | |
Table Storage Auditing option. Valid strings are NONE, CHANGES, and ALL. DATATYPE: String. | |
Table Storage Log Data Changes value. DATATYPE: Boolean. | |
Table Storage Edit Proc value. DATATYPE: String. | |
Table Storage Encoding option. Valid strings are ASCII, EBCDIC, and NONE. DATATYPE: String. | |
Indicates whether the Table Storage is In Database. DATATYPE: Boolean. | |
DB2 OS/390 V8 and later only. Indicates whether a table is volatile. DATATYPE: Boolean. | |
Table Storage Restrict On Drop value. DATATYPE: Boolean. | |
Table Storage Valid Proc value. DATATYPE: String. | |
Definition of the entity. DATATYPE: String. | |
Dimension Table Type. Valid strings are FIXED, TYPE1, TYPE2 or TYPE3. DATATYPE: String. | |
Dimensional Model Table Type. Valid strings are DIMENSION, FACT, SNOWFLAKE or UNDEFINED. DATATYPE: String. | |
Sets the Dimensional Model Table Type Override on or off. Valid values are true or false. DATATYPE: Boolean. | |
If true, the Table is not generated in the DDL. DATATYPE: Boolean. | |
Name of the entity in the logical model. DATATYPE: String. | |
FreeListGroups of the entity storage. DATATYPE: Integer. | |
FreeLists of the entity storage. DATATYPE: Integer. | |
True if this entity is not affected by naming standards name updates. DATATYPE: Boolean. | |
Generate PostSQL option of the entity. DATATYPE: Boolean. | |
Generate PreSQL option of the entity. DATATYPE: Boolean. | |
Date and time a Google BigQuery table is deleted along with all of the data contained within that table. DATATYPE: String. | |
Name of the key used to encrypt your encryption keys as part of the Google BigQuery Cloud Key Management Service (KMS). DATATYPE: String. | |
Name of a Google BigQuery label that you can apply to your resources, such as your datasets, tables, and views. DATATYPE: String. | |
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. | |
Time period by which Google BigQuery tables are partitioned. DATATYPE: String. | |
Y equals Boolean True if all queries for this table require a partition filter. DATATYPE: String. | |
Type of partitioning used to partition Google BigQuery tables. DATATYPE: String. | |
Range used to partition Google BigQuery tables. DATATYPE: String. | |
Greenplum only. GreenplumDistributionColumns property of the table. DATATYPE: String. | |
Greenplum only. GreenplumDistributionRandom property of the table. DATATYPE: Boolean. | |
Physical models only. Period the growth rate is based on. Valid strings are Day, Week, Month, Quarter, or Year. DATATYPE: String. | |
Physical models only. Determines how fast a table grows. DATATYPE: Integer. | |
Physical models only. Type on which the growth rate is based. Valid strings are Percent or Rows. DATATYPE: String. | |
GUID of the entity as assigned by ER/Studio. Each entity has a unique GUID. DATATYPE: String. | |
Fix option of the entity storage. DATATYPE: Boolean. | |
Row Lock option of the entity storage. DATATYPE: Boolean. | |
Storage In option of the entity storage. DATATYPE: Boolean. | |
Hive only. Holds AsSelect value for the table. DATATYPE: String. | |
Hive only. Holds the comma-separated list of Clustered By columns. DATATYPE: String. | |
Hive only. External property of the table. If true, the table is created externally: CREATE EXTERNAL TABLE ... DATATYPE: Boolean. | |
Hive only. Determines where the table is stored in the HDFS. DATATYPE: String. | |
Hive only. Determines the NUM_BUCKETS value for the table. DATATYPE: Integer. | |
Hive only. Corresponds to COLLECTION ITEMS TERMINATED BY of the ROW FORMAT clause in the create table statement. It requires a true HiveRowFormatDelimited. DATATYPE: String. | |
Hive only. Pertains to the RowFormat of the table. If true, the table is created with ROW FORMAT DELIMITED. You cannot set to true if a RowFormat SerDe is specified via HiveStoredBySerDeHandler. DATATYPE: Boolean. | |
Hive only. Corresponds to ESCAPED BY part of the FIELDS TERMINATED BY clause in the create table statement. It requires a set HiveRowFormatFields. DATATYPE: String. | |
Hive only. Corresponds to FIELDS TERMINATED BY of the ROW FORMAT clause in the create table statement. It requires a true HiveRowFormatDelimited. DATATYPE: String. | |
Hive only. Corresponds to LINES TERMINATED BY of the ROW FORMAT clause in the create table statement. It requires a true HiveRowFormatDelimited. DATATYPE: String. | |
Hive only. Corresponds to MAP KEYS TERMINATED BY of the ROW FORMAT clause in the create table statement. It requires a true HiveRowFormatDelimited. DATATYPE: String. | |
Hive only. Corresponds to NULL DEFINED AS of the ROW FORMAT clause in the create table statement. It requires a true HiveRowFormatDelimited and is available on DBServers beginning with Hive 0.13. DATATYPE: String. | |
Hive only. Name of the SerDe handler for ROW FORMAT. It requires a false HiveRowFormatDelimited. DATATYPE: String. | |
Hive only. Holds the comma-separated properties for ROW FORMAT SerDe. It requires a set HiveRowFormatSerDeHandler. DATATYPE: String. | |
Hive only. Holds the comma-separated list of Skewed By columns. DATATYPE: String. | |
Hive only. Holds the Skewed On Values for the table. DATATYPE: String. | |
Hive only. Holds the comma-separated list of Sorted By columns. DATATYPE: String. | |
Hive only. Is file format in the STORED AS clause. Valid strings are BINARYFILE, ORC, RCFILE, SEQUENCEFILE, TEXTFILE. Output also includes InputOutput Handler clause. HiveStoredBySerDeHandler must be empty. DATATYPE: String. | |
Hive only. 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. | |
Hive only. Read only. 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. | |
Hive only. Read only. 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. | |
Hive only. Name of the SerDe handler that appears in the STORED BY clause of the Create Table statement. It requires an empty HiveStoredAs. DATATYPE: String. | |
Hive only. Holds the comma-separated properties for STORED BY SerDe. It requires a set HiveStoredBySerDeHandler. DATATYPE: String. | |
Hive only. Holds the TblProperties value for the table. DATATYPE: String. | |
ID of the entity. Assigned by ER/Studio. Each entity in a diagram has a unique ID. DATATYPE: Integer. | |
Specifies the Tablespace in which to create the Index for this table. DATATYPE: String. | |
Informix Online and Informix 9.x and later only. InformixLockMode property of the table. Possible values include 0 = PAGE and 1 = ROW. DATATYPE: Integer. | |
Initial extent of the entity storage. DATATYPE: Integer. | |
Initial Transactions of the entity storage. DATATYPE: Integer. | |
InterModelID of the object as assigned by ER/Studio. DATATYPE: Integer. | |
Physical models only. Determines whether a table is a static table or will grow. DATATYPE: Boolean. | |
Applies to DataLineage and displays when the data was last sourced only if the parent model is physical and is enabled for data movement. DATATYPE: String. | |
Specifies that the table's data are physically replicated on each partition on which the table is defined. DATATYPE: Boolean. | |
Controls the logical/physical only Entity Property. DATATYPE: Boolean. | |
Identifies the Tablespace in which the values of any long columns are stored. DATATYPE: String. | |
MaxExtents of the entity storage. Parameter can be positive integer as string or UNLIMITED. DATATYPE: String. | |
Physical models only. Maximum number of rows a table can hold. DATATYPE: Integer. | |
MaxTransactions of the entity storage. DATATYPE: Integer. | |
MinExtents of the entity storage. DATATYPE: Integer. | |
Type of the table for MySQL model. Valid strings are MYISAM and INNODB. DATATYPE: String. | |
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. | |
Netezza 4.6, 5.0 and later only. NetezzaDistributionColumns property of the table. DATATYPE: String. | |
Netezza 4.6, 5.0 and later only. NetezzaDistributionRandom property of the table. DATATYPE: Boolean. | |
Netezza 6.0 and later only. Organization Key property of the table and contains up to four comma-separated columns. DATATYPE: String. | |
Next extent of the entity storage. DATATYPE: Integer. | |
Determines whether there is no logging (true) or logging (false) in the entity storage. DATATYPE: Boolean. | |
Note of the entity. DATATYPE: String. | |
Sets/unsets the Oracle External Table Access Driver property. It can be set only if the OracleExternalTables property is TRUE. | |
Sets/unsets the Oracle External Table Access Parameters property. It can be set only if the OracleExternalTables property is TRUE. | |
BufferPool of the entity storage. Valid strings are KEEP, RECYCLE, DEFAULT, and NONE. DATATYPE: String. | |
Cache property of the entity storage. Must be heap organized. True for Cache on, false for Cache off. DATATYPE: Boolean. | |
Sets/unsets the Oracle External Table Default Directory property. It can be set only if the OracleExternalTables property is TRUE. | |
Sets/unsets the Oracle External Table property. | |
Sets/unsets the Oracle External Table Location property. It can be set only if the OracleExternalTables property is TRUE. | |
Degrees property of the entity storage. Degrees is only valid if parallel is true. DATATYPE: String. | |
Index property of the entity storage. It is true if index organized, false if heap organized. DATATYPE: Boolean. | |
Indexes property of the entity storage. Instances is only valid if parallel is true. DATATYPE: String. | |
Parallel option of the entity storage. DATATYPE: Boolean. | |
Oracle 9 and later only. OracleRowMovement property of the table. Not supported for non-partitioned index-organized tables. DATATYPE: Boolean. | |
Owner of the entity. DATATYPE: String. | |
Percent free of the entity storage. DATATYPE: Integer. | |
Percent increase of the entity storage. DATATYPE: Integer. | |
Percent used by the entity storage. DATATYPE: Integer. | |
Snowflake only. Holds the persistence type for a Snowflake table. Possible values returned are TRANSIENT, VOLATILE, GLOBAL, LOCAL, TEMPORARY, and PERMANENT. | |
PostSQL of the entity. DATATYPE: String. | |
PreSQL of the entity. DATATYPE: String. | |
Physical models only. Current number of rows in a table. DATATYPE: Integer. | |
DataLineage and applies only if the parent model is physical and is enabled for data movement. This property tells how often the data is sourced. DATATYPE: String. | |
Storage location of the entity. DATATYPE: String. | |
Identity Gap option of the entity storage. It must be a positive integer (in kilobytes). DATATYPE: Integer. | |
Locking Scheme option of the entity storage. The possible values are ALLPAGES, DATAPAGES or DATAROWS. DATATYPE: String. | |
Max Rows Per Page option of the Sybase table storage. DATATYPE: Integer. | |
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. | |
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. | |
Reserve Page Gap option of the entity storage. It must be a positive integer (in kilobytes). DATATYPE: Integer. | |
System name of the AS400 table. DATATYPE: String. | |
TableDDL of the entity. DATATYPE: String. | |
Name of the table in a physical model. DATATYPE: String. | |
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. | |
Before Journal option of the entity storage. The possible values are – --, NO, DUAL or the empty string (meaning nothing has been specified). DATATYPE: String. | |
Teradata 12 and later only. TeradataChecksum property of the table. Possible values are Default, All, High, Medium, Low, None, or empty (no DDL output). DATATYPE: String. | |
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. | |
DuplicateRowControl option of the entity storage. The possible values are SET, MULTISET or the empty string (meaning nothing is specified). DATATYPE: String. | |
Fallback protection option of the entity storage. If it is true then Fallback protection is used for the table. DATATYPE: Boolean. | |
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. | |
Specifies the table space in which the text/image columns are stored for the table. DATATYPE: String. | |
Text label of the AS400 table. DATATYPE: String. |
See Also