ColumnMetaData Object

Use the AppConnMetaData object to manage data based in table columns.

Method use, syntax, and parameters:

ColumnType Property

Used to get the type of a column within a Verastream table.

Syntax

object.ColumnType

Part Description
object A ColumnMetaData object

Remarks

Use the ColumnType property to get the type of a column. The enumeration values for AppConnColumnType are defined in the Type Library.

Column Type ColumnType Return Value
Integer Column  0
Text Column  1
Float Column  2

Example

Dim Verastream_Session As AppConnModel
Dim strModelName, strServerName As String
Dim ColumnMeta As ColumnMetaData

strModelName = "CCSDemo"
strServerName = "localhost"
Set Verastream_Session = New AppConnModel
Verastream_Session.ConnectToModel strServerName, strModelName

Set ColumnMeta = Verastream_Session.GetColumnMetaData("Transactions", "AcctNumber")
MsgBox ("Column type = " & ColumnMeta.ColumnType)

Verastream_Session.Disconnect
Set Verastream_Session = Nothing
Set ColumnMeta = Nothing

Description Property

Used to get the description of a column within a Verastream table.

Syntax

object.Description

Part Description
object A ColumnMetaData object

Remarks

Use the Description property to get the description of a column within a Verastream table.

Example

Dim Verastream_Session As AppConnModel
Dim strModelName, strServerName As String
Dim ColumnMeta As ColumnMetaData

strModelName = "CCSDemo"
strServerName = "localhost"
Set Verastream_Session = New AppConnModel
Verastream_Session.ConnectToModel strServerName, strModelName

Set ColumnMeta = Verastream_Session.GetColumnMetaData("Transactions", "AcctNumber")
MsgBox ("Column description = " & ColumnMeta.Description)

Verastream_Session.Disconnect
Set Verastream_Session = Nothing
Set ColumnMeta = Nothing

IsKey Property

Used to get the key flag of a column within a Verastream table.

Syntax

object.IsKey

Part Description
object A ColumnMetaData object

Remarks

Use the IsKey property to get the key flag of a column within a Verastream table. It returns a boolean value about whether the column is a key field or not.

Example

Dim Verastream_Session As AppConnModel
Dim strModelName, strServerName As String
Dim ColumnMeta As ColumnMetaData

strModelName = "CCSDemo"
strServerName = "localhost"
Set Verastream_Session = New AppConnModel
Verastream_Session.ConnectToModel strServerName, strModelName

Set ColumnMeta = Verastream_Session.GetColumnMetaData("Transactions", "AcctNumber")
MsgBox ("Is the column a key for the table?  " & ColumnMeta.IsKey)

Verastream_Session.Disconnect
Set Verastream_Session = Nothing
Set ColumnMeta = Nothing

Max Property

Used to get the maximum value of a column within a Verastream table.

Syntax

object.Max

Part Description
object A ColumnMetaData object

Remarks

Use the Max property to get the maximum value of a column within a Verastream table. The meaning of the max value depends on the type of the column. For integer and float columns, it represents the maximum value for the column. For string columns, it represents the maximum number of characters in the string.

Example

Dim Verastream_Session As AppConnModel 
Dim strModelName, strServerName As String 
Dim ColumnMeta As ColumnMetaData 

strModelName = "CCSDemo" 
strServerName = "localhost" 
Set Verastream_Session = New AppConnModel 
Verastream_Session.ConnectToModel strServerName, strModelName 

Set ColumnMeta = Verastream_Session.GetColumnMetaData("Transactions", "AcctNumber") 
MsgBox ("Column maximum = " & ColumnMeta.Max) 

Verastream_Session.Disconnect 
Set Verastream_Session = Nothing 
Set ColumnMeta = Nothing 

MetaDataType Property

Used to get the metadata type of a column within a Verastream table.

Syntax

object.MetaDataType

Part Description
object A ColumnMetaData object

Remarks

Use the MetaDataType property to get the type of metadata within a Verastream table. The enumeration values for AppConnMetaDataType are defined in the Type Library.

Metadata Types
AttributeMeta
OperationMeta
RecordSetMeta
FieldMeta
VariableMeta
TableMeta
ColumnMeta
ProcedureMeta

Example

Dim Verastream_Session As AppConnModel
Dim strModelName, strServerName As String
Dim ColumnMeta As ColumnMetaData

strModelName = "CCSDemo"
strServerName = "localhost"
Set Verastream_Session = New AppConnModel
Verastream_Session.ConnectToModel strServerName, strModelName

Set ColumnMeta = Verastream_Session.GetColumnMetaData("Transactions", "AcctNumber")
MsgBox ("Metadata type = " & ColumnMeta.MetaDataType)

Verastream_Session.Disconnect
Set Verastream_Session = Nothing
Set ColumnMeta = Nothing

Min Property

Used to get the minimum value of a column within a Verastream table.

Syntax

object.Min

Part Description
object A ColumnMetaData object

Remarks

Use the Min property to get the minimum value of a column within a Verastream table. The meaning of the min value depends on the type of the column. For integer and float columns, it represents the minimum value for the column. For string columns, it represents the minimum number of characters in the string.

Example

Dim Verastream_Session As AppConnModel 
Dim strModelName, strServerName As String 
Dim ColumnMeta As ColumnMetaData 

strModelName = "CCSDemo" 
strServerName = "localhost" 
Set Verastream_Session = New AppConnModel 
Verastream_Session.ConnectToModel strServerName, strModelName 

Set ColumnMeta = Verastream_Session.GetColumnMetaData("Transactions", "AcctNumber") 
MsgBox ("Column minimum = " & ColumnMeta.Min) 

Verastream_Session.Disconnect 
Set Verastream_Session = Nothing 
Set ColumnMeta = Nothing 

Name Property

Used to get the name of a column within a Verastream table.

Syntax

object.Name

Part Description
object A ColumnMetaData object

Remarks

Use the Min property to get the minimum value of a column within a Verastream table. The meaning of the min value depends on the type of the column. For integer and float columns, it represents the minimum value for the column. For string columns, it represents the minimum number of characters in the string.

Example

Dim Verastream_Session As AppConnModel 
Dim strModelName, strServerName As String 
Dim ColumnMeta As ColumnMetaData 

strModelName = "CCSDemo" 
strServerName = "localhost" 

Set Verastream_Session = New AppConnModel 
Verastream_Session.ConnectToModel strServerName, strModelName 

Set ColumnMeta = Verastream_Session.GetColumnMetaData("Transactions", "AcctNumber") 
MsgBox ("Column name = " & ColumnMeta.Name) 

Verastream_Session.Disconnect 
Set Verastream_Session = Nothing 
Set ColumnMeta = Nothing