Libraries.Data.Database.EditTable Documentation

The EditTable query represents the ALTER TABLE command of the SQL (Structured Query Language) language. This query allows for table manipulations by adding, dropping, or modify columns.

Example Code

use Libraries.Data.Database.Database
use Libraries.Data.Database.EditTable

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

EditTable query
query:SetTable("tasks")
query:AddColumn("dueDate", "date")

database:EditTable(query)

Inherits from: Libraries.Language.Object, Libraries.Data.Database.Query, Libraries.Data.Database.Support.RemappableName

Actions Documentation

AddColumn(text column, text dataType)

This action adds a column to the table.

Parameters

  • text column: The name of the column to add
  • text dataType: The associated data type of the column to add

Example

use Libraries.Data.Database.EditTable

EditTable query
query:SetTable("tasks")
query:AddColumn("dueDate", "date")

AddNameRemap(text newName, Libraries.Data.Database.Support.RemappableName original)

Adds objects that have been remapped to single table for reference in actions called when building the query to text. Examples of RemappableNames are columns, tables, and subqueries.

Parameters

AddPreparedParameter(Libraries.Data.Database.Support.Parameter param)

At the plugin level prepared statements are used to add a layer of security from injection attacks. Every parameter in the prepared paramter array will be stripped from the actual query text and set appropriately at the plugin level.

Parameters

AddSubquery(text name, Libraries.Data.Database.Find subquery)

Adds a subquery to this query. Only Find queries are supported for now. A Subquery is a query that exists another outer query. An example could be a Find where the table to search through is actually the result of another query.

Parameters

AddTableNameRemap(text table, text newName)

This adds a name that can be used in the place of a table. This action does not set the table of this query but only a name that can be referenced if the table is added.

Parameters

  • text table: The name of the table to set for this query
  • text newName

Example

use Libraries.Data.Database.Find

Find query
query:SetTable("orders", "o")
query:AddTableNameRemap("members", "m")
query:AddInnerJoin("m", "o:name = m:name")

AddTableReference(text table)

Internal. Queries keep track of what tables are referenced to check for ambiguous column names

Parameters

  • text table

AlterAutoIncrement(integer newStart)

This action allows the auto increment value to be changed. The auto increment works by incrementing and adding a value to a row each time a new row is inserted. If the value is changed then on the next insert the incremented value will start at the one set here.

Parameters

  • integer newStart: The integer where auto increment will start at on the next insert

Example

use Libraries.Data.Database.EditTable

EditTable query
query:SetTable("tasks")
query:AlterAutoIncrement(1000)

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.

Parameters

Return

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

Example

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

ConvertToStructuredQueryLanguage()

This action returns the query as text in Structured Query Language (SQL). Not intended to be used directly by the user, this is more for internals of the API to make calls to the database

Return

text:

DropColumn(text column)

This action drops a column from a table.

Parameters

  • text column

Example

use Libraries.Data.Database.EditTable

EditTable query
query:SetTable("tasks")
query:DropColumn("dueDate")

EmptyPreparedParameters()

Clears the prepared parameter list. Necessary because running a query again without emptying the list will cause the list of parameters to not shrink

EmptyTableReferences()

Empties the table references hash table.

Equals(Libraries.Language.Object object)

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

Parameters

Return

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

Example

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

Filter(text value)

Some queries make use of the filter which is an expression checked against the values of the columns in the rows of a database table. The filter is written using Quorum syntax and will be type checked to see if it's valid. Column names can be used and the names made by the user using name remaps. An example filter would be "priority < 4" where priority is a column that exists and can be mapped to an integer.

Parameters

  • text value: The expression to be used in the query

Example

use Libraries.Data.Database.Delete

Delete query
query:SetTable("orders")
query:Filter("priority < 4")

GetColumn()

This action returns the name of the column associated with this query.

Return

text: The name of the column that will be affected or added by this query

Example

use Libraries.Data.Database.AlterTable

GetDatabaseMetaData()

Returns the meta data object set for this query

Return

Libraries.Data.Database.DatabaseMetaData:

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

GetNameRemaps()

Grabs the table containing all aliases that have been set in this query

Return

Libraries.Containers.HashTable:

GetPreparedParameters()

Used at the plugin level to get all parameters that need to be set in the prepared statement

Return

Libraries.Containers.Array:

GetRawFilter()

Returns the filter as given by the user. The filter will be converted to a syntax accepted by the database server and this action returns whatever the user originally typed

Return

text:

GetRemappedName()

Returns the alias

Return

text:

GetTable()

Returns the table this query is meant to be ran against

Return

text:

GetTableReferences()

Internal. Used by other actions to grab what tables are referenced to check if column names are valid.

Return

Libraries.Containers.HashTable:

GetTranslatedFilter()

Returns the filter as translated by the quorum compiler. The filter will be converted to a syntax accepted by the database server and this action returns whatever the user originally typed

Return

text:

ModifyColumn(text column, text dataType)

This action allows the type of a column to be changed.

Parameters

  • text column: The name of the column to modify
  • text dataType: The new data type the column will have after the modify

Example

use Libraries.Data.Database.EditTable

EditTable query
query:SetTable("tasks")
query:ModifyColumn("startDate", "datetime")

RenameTable(text newName)

This action renames a table in the database

Parameters

  • text newName: The new name to give to a table

Example

use Libraries.Data.Database.EditTable

EditTable query
query:SetTable("tasks")
query:RenameTable("unfinished_tasks")

SetDatabaseMetaData(Libraries.Data.Database.DatabaseMetaData meta)

Sets the DatabaseMetaData for this query. This is necessary for checking things like if a table referenced exists or if a filter has valid column references.

Parameters

SetRemappedName(text remappedName)

Sets the alias

Parameters

  • text remappedName

SetTable(text table)

This action sets the table of the query. Most queries run against a single table and this action is used to set which table the query will affect or search.

Parameters

  • text table: The name of the table to set for this query

Example

use Libraries.Data.Database.Find

Find query
query:SetTable("members")

SetTable(text table, text newName)

This action sets the table of the query. Most queries run against a single table and this action is used to set which table the query will affect or search. This action also lets you rename the table so in filters a different name can be used.

Parameters

  • text table: The name of the table to set for this query
  • text newName

Example

use Libraries.Data.Database.Find

Find query
query:SetTable("members", "m")

SetTableWithName(text table, text newName)

This action sets the table of the query. Most queries run against a single table and this action is used to set which table the query will affect or search. This action also lets you rename the table so in filters a different name can be used.

Parameters

  • text table: The name of the table to set for this query
  • text newName

Example

use Libraries.Data.Database.Find

Find query
query:SetTableWithName("members", "m")

ToText()

By default convert to structured query language.

Return

text: