Libraries.Data.Database.QueryResultToDataFrameConverter Documentation

This class is used to take a QueryResult from a query such as a Find and take the data from a result and put all of the data into a DataFrame. The DataFrame class makes it easier to use different statistical tests from the Statisics Library.

Example Code

use Libraries.Data.Database.Database
use Libraries.Data.Database.Find
use Libraries.Data.Database.QueryResult
use Libraries.Data.Database.QueryResultToDataFrameConverter
use Libraries.Compute.Statistics.DataFrame

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)

QueryResultToDataFrameConverter converter
DataFrame frame = converter:Convert(result)

output frame:ToText()

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.
Convert(Libraries.Data.Database.QueryResult result)This action takes a QueryResult and will iterate through it and put every row into a DataFrame and then return that DataFrame.
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.

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.

Convert(Libraries.Data.Database.QueryResult result)

This action takes a QueryResult and will iterate through it and put every row into a DataFrame and then return that DataFrame.

Example Code

use Libraries.Data.Database.Database
    use Libraries.Data.Database.Find
    use Libraries.Data.Database.QueryResult
    use Libraries.Data.Database.QueryResultToDataFrameConverter
    use Libraries.Compute.Statistics.DataFrame
    
    Database database
    database:Connect("localhost", "myDatabase", "user", "SuperSecret456")
    
    Find find
    find:AddColumn("price")
    find:SetTable("orders")
    
    QueryResult result = database:Find(find)
    
    QueryResultToDataFrameConverter converter
    DataFrame frame = converter:Convert(result)

Parameters

Return

Libraries.Compute.Statistics.DataFrame: Returns a DataFrame that contains all the data from the QueryResult

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.