Libraries.Data.Database.QueryMetaData Documentation
This class represents meta data for a particular query back from a database. A common use for this used to find out how many columns are in a query which can help with iterating through the result of a query.
Example Code
use Libraries.Data.Database.Database
use Libraries.Data.Database.Find
use Libraries.Data.Database.QueryResult
use Libraries.Data.Database.QueryMetaData
Database database
database:Connect("localhost", "myDatabase", "user", "SuperSecret456")
Find find
find:AddColumn("itemName")
find:AddColumn("quantity")
find:AddColumn("price")
find:SetTable("orders")
QueryResult result = database:Find(find)
// grab how many columns there are in the result set from the metadata
QueryMetaData meta = result:GetQueryMetaData()
integer size = meta:GetSize()
repeat while result:HasNext()
output "row: "
result:Next()
i = 0
repeat while i < size
text value = result:GetText(i)
output value + ", "
i = i + 1
end
output ""
end
Inherits from: Libraries.Language.Object
Summary
Actions Summary Table
Actions | Description |
---|---|
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(integer column) | Returns the name of the column. |
GetSize() | Returns the number of columns in the query. |
GetType(integer column) | Returns the raw type of a 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
- Libraries.Language.Object: The object to compare to.
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
- Libraries.Language.Object: The to be compared.
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(integer column)
Returns the name of the column. If the column was aliased this will return the alias
Parameters
Return
text:
GetSize()
Returns the number of columns in the query.
Return
integer:
GetType(integer column)
Returns the raw type of a column. Using DatabaseTypeConstants can help determine what the associated Quorum Type is.
Parameters
Return
integer: