Libraries.Data.Database.QueryResult Documentation
The QueryResult class allows the user to iterate through a result given back from a database query. The result set that is returned from a query can be huge depending on the amount of data on the database so the default method of going through a result is iterate through it row by row rather than return all data at once.
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)
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. |
GetInteger(integer column) | This action returns a column from the current row as an integer. |
GetInteger(text column) | This action returns a column from the current row as an integer. |
GetQueryMetaData() | This action returns metadata related to the query result. |
GetText(integer column) | This action returns a column from the current row as text. |
GetText(text column) | This action returns a column from the current row as text. |
HasNext() | This action returns true if there is another row in the query result to iterate to. |
Next() | This action moves the QueryResult to the next row. |
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.
GetInteger(integer column)
This action returns a column from the current row as an integer. This action grabs a column by position.
Example Code
use Libraries.Data.Database.Database
use Libraries.Data.Database.Find
use Libraries.Data.Database.QueryResult
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)
repeat while result:HasNext()
result:Next()
output result:GetInteger(1)
end
Parameters
- integer column: The position of the column to return
Return
integer: Returns the column value as an integer
GetInteger(text column)
This action returns a column from the current row as an integer. This action grabs a column by name.
Example Code
use Libraries.Data.Database.Database
use Libraries.Data.Database.Find
use Libraries.Data.Database.QueryResult
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)
repeat while result:HasNext()
result:Next()
output result:GetInteger("quantity")
end
Parameters
- text column: The name of the column to return
Return
integer: Returns the column value as an integer
GetQueryMetaData()
This action returns metadata related to the query result. The metadata has information about the returned columns such as names, types, and how many were returned. Note that the metadata can only tell you how many columns in the result not how many rows.
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)
QueryMetaData meta = result:GetQueryMetaData()
integer size = meta:GetSize()
output "Number of Columns Returned: " + size
Return
Libraries.Data.Database.QueryMetaData: Returns the QueryMetaData of this QueryResult
GetText(integer column)
This action returns a column from the current row as text. This action grabs a column by position.
Example Code
use Libraries.Data.Database.Database
use Libraries.Data.Database.Find
use Libraries.Data.Database.QueryResult
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)
repeat while result:HasNext()
result:Next()
output result:GetText(0)
end
Parameters
- integer column: The position of the column to return
Return
text: Returns the column value as text
GetText(text column)
This action returns a column from the current row as text. This action grabs a column by name.
Example Code
use Libraries.Data.Database.Database
use Libraries.Data.Database.Find
use Libraries.Data.Database.QueryResult
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)
repeat while result:HasNext()
result:Next()
output result:GetText("itemName")
end
Parameters
- text column: The name of the column to return
Return
text: Returns the column value as text
HasNext()
This action returns true if there is another row in the query result to iterate to.
Example Code
use Libraries.Data.Database.Database
use Libraries.Data.Database.Find
use Libraries.Data.Database.QueryResult
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)
boolean hasResult = result:HasNext()
Return
boolean: Returns true if there another row in this QueryResult. If there is then Next() will move this QueryResult to the next row.
Next()
This action moves the QueryResult to the next row. A QueryResult only allows for grabbing columns from one row at a time so while iterating through a whole set of a result this action is used when a user wants to move on to the next row.
Example Code
use Libraries.Data.Database.Database
use Libraries.Data.Database.Find
use Libraries.Data.Database.QueryResult
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)
repeat while result:HasNext()
result:Next()
output "row found"
end