Core properties and methods

Public AutoNumberColumn As xf_DbSchema_Column

Table autonumber column

Public Property Get ColumnNameOrEmpty(ColumnSchema As xf_DbSchema_Column) As String

If the passed column schema is nothing, return an empty string, otherwise return the column name

Public Columns As Collection

Table columns collection

Public Property Get ColumnSchema(ColumnName As String) As xf_DbSchema_Column

Return the specified column schema object

Public FirstNonKeyTextColumn As xf_DbSchema_Column

First Non-Key Text column

Public Property Get FormatPkWhere(ParamArray PKValList() As Variant) As String

Format a WHERE clause for inclusion in SQL from a list of PK column values. Only one value is required if the table has a single column PK.

Public Property Get FormatPkWhereInternal(ArrayVar As Variant) As String

Format a WHERE clause for inclusion in SQL from a list of PK column values. Only one value is required if the table has a single column PK. The list is a paramarray passed as a variant.


Public Property Get GetEmptySchemaList() As xf_DataList

Return a DataList object set up with the schema for the table, and with a single empty row added. The DataList schema is created by calling: p_EmptySchemaList.AddSQLResultsetDbConn Parent.DBConn, "SELECT * FROM " & TableNameBracketed & " WHERE 1=0"

Public Function GetIdColumnFrameworkFKName(ColumnName As String) As String

Get the '_FK_ID' column name given an '_ID' column name, or return empty string

Public Function GetIdColumnFrameworkLUName(ColumnName As String) As String

Get the '_LU_ID' column name given an '_ID' column name, or return empty string

Public Property Get HasIsHiddenColumn() As Boolean

Does the table have an 'IsHidden' or 'IsDeleted' column ?

Public Property Get HasMemoColumns() As Boolean

Does the table contain memo columns ? If so, it restricts the recordset types that may be used.


Public Property Get HasOwnerColumn() As Boolean

Does the table have an owner column ? (not yet implemented)

Public Property Get HasSinglePKCol() As Boolean

Does the table have a single column PK ?

Public LocalIdColumn As xf_DbSchema_Column

Table Local ID column (for table shadowing)

Public Property Get MetaDataAdded() As Boolean

Metadata: was user metadata read ?

Public OrderIndexColumn As xf_DbSchema_Column

'Order Index' column

Public Property Get Parent() As xf_DbSchema

The parent schema object

Public Property Get PKAutoGenerated() As Boolean

Is the table PK an identity/autonum column

Public Property Get PKColNameList() As String

Return a comma separated list of the PK column names for the table

Public Property Get PKLastColName() As String

Return either the single column PK of the table, or the last column of the PK if there is a multi column PK

Public Property Get PKLastColType() As Variant

Return the native type of either the single column PK of the table, or the last column of the PK if there is a multi column PK

Public Property Get PKSingleColNameOrEmpty() As String

Return either the single column PK of the table, or an empty string if there is no PK or a multi column PK

Public PrimaryKeyColumns As Collection

Table primary key columns collection

Public Function ReadTableSchema(TableName As String, DBSchema As xf_DbSchema, Optional LocalIDColumnName As String = "", Optional AllowNoSQLMetaData As Boolean = False) As Boolean

Read the table schema from the database. For an Access database, use DAO. For MSSQL linked tables, use specifically named MetaData views.


Public SoftDeleteColumn As xf_DbSchema_Column

'Soft Delete' column

Public Property Get TableDescriptionPlural() As String

Metadata: the plural description of the table purpose

Public Property Get TableDescriptionSingular() As String

Metadata: the singular description of the table purpose

Public Property Get TableName() As String

The table name

Public Property Get TableNameBracketed() As String

The table name enclosed in square brackets

Public Property Get TableNameShadow() As String

The name of the table's shadow table

Public Property Get TableNameShadowBracketed() As String

The name of the table's shadow table enclosed in square brackets

Public Property Get TableProcessingOrder() As Integer

Metadata: the processing order of the tables - tables with dependencies are later

Public Property Get TableType() As xf_DbTableTypeEnum

The name of the table's shadow table (xf_DbTableType_MSAccessInternal, xf_DbTableType_MSAccessLinked, xf_DbTableType_MssqlLinked, xf_DbTableType_MssqlDirect)