Libraries.Data.Database.DatabaseColumn Documentation

The DatabaseColumn class contains information about a column in a database table. This class is useful when checking the type of a column which is used interally in the system for type checking filter expressions.

Example Code

use Libraries.Data.Database.DatabaseMetaData
use Libraries.Data.Database.DatabaseTable
use Libraries.Data.Database.DatabaseColumn

Database database
database:Connect("localhost", "myDatabase", "user", "SuperSecret456")

DatabaseMetaData meta = database:GetDatabaseMetaData()
DatabaseTable table = meta:GetTable("myDB")
DatabaseColumn column = table:GetColumn("id")
output column:GetName()

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetHashCode()This action gets the hash code for an object.
GetName()This action returns the name of this column as returned by the database
GetRawType()This action returns the raw integer returned by the database, which indicates the type recognized by the system.
GetType()This action returns the type of this column based on the raw type.
SetName(text name)This action sets the name of this column.

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Example Code

Object o
        Object t
        integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Example Code

use Libraries.Language.Object
        use Libraries.Language.Types.Text
        Object o
        Text t
        boolean result = o:Equals(t)

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

GetHashCode()

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode()

Return

integer: The integer hash code of the object.

GetName()

This action returns the name of this column as returned by the database

Return

text:

GetRawType()

This action returns the raw integer returned by the database, which indicates the type recognized by the system.

Return

integer:

GetType()

This action returns the type of this column based on the raw type. Used internally for type checking.

Return

Libraries.Language.Compile.Symbol.Type:

SetName(text name)

This action sets the name of this column. This is used by the system when the metadata is grabbed. Not meant to be used the user.

Parameters