Relintai/pandemonium_engine
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine.git synced 2025-05-15 01:42:07 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs for the new TableBuilder methods.

Browse Source
This commit is contained in:
Relintai 2025-05-12 11:16:05 +02:00
parent 0cb871a29a
commit ebbcaead70
1 changed files with 76 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

77
modules/database/doc_classes/TableBuilder.xml
View File

@ -15,6 +15,29 @@
<tutorials>
</tutorials>
<methods>
<method name="add_column">
<return type="TableBuilder" />
<description>
Adds an [code]ADD COLUMN[/code] statement.
Equivalent to:
[codeblock]
result += "ADD COLUMN "
[/codeblock]
</description>
</method>
<method name="alter_table">
<return type="TableBuilder" />
<argument index="0" name="table_name" type="String" />
<description>
Adds an [code]ALTER TABLE[/code] statement.
Equivalent to:
[codeblock]
result += "ALTER TABLE ";
result += p_table_name;
result += " ";
[/codeblock]
</description>
</method>
<method name="auto_increment">
<return type="TableBuilder" />
<description>
@ -47,7 +70,7 @@
</method>
<method name="create_table">
<return type="TableBuilder" />
<argument index="0" name="value" type="String" />
<argument index="0" name="table_name" type="String" />
<description>
Adds a [code]CREATE TABLE[/code] statement.
Equivalent to:
@ -78,6 +101,19 @@
[/codeblock]
</description>
</method>
<method name="drop_column">
<return type="TableBuilder" />
<argument index="0" name="column_name" type="String" />
<description>
Adds a [code]DROP COLUMN[/code] statement.
Equivalent to:
[codeblock]
result += "DROP COLUMN ";
result += p_column_name;
result += " ";
[/codeblock]
</description>
</method>
<method name="drop_table">
<return type="TableBuilder" />
<argument index="0" name="name" type="String" default="&quot;&quot;" />
@ -100,6 +136,16 @@
[/codeblock]
</description>
</method>
<method name="end_command">
<return type="TableBuilder" />
<description>
Adds an end command statement.
Equivalent to:
[codeblock]
result += ";";
[/codeblock]
</description>
</method>
<method name="foreign_key">
<return type="TableBuilder" />
<argument index="0" name="name" type="String" />
@ -201,6 +247,35 @@
result += "REFERENCES " + table + " (" + name + ") ";
</description>
</method>
<method name="rename_column_to">
<return type="TableBuilder" />
<argument index="0" name="column_name" type="String" />
<argument index="1" name="new_column_name" type="String" />
<description>
Adds a [code]RENAME COLUMN[/code] statement.
Equivalent to:
[codeblock]
result += "RENAME COLUMN ";
result += p_column_name;
result += " TO ";
result += p_new_column_name;
result += " ";
[/codeblock]
</description>
</method>
<method name="rename_to">
<return type="TableBuilder" />
<argument index="0" name="table_name" type="String" />
<description>
Adds a [code]RENAME TO[/code] statement.
Equivalent to:
[codeblock]
result += "RENAME TO ";
result += p_table_name;
result += " ";
[/codeblock]
</description>
</method>
<method name="reset">
<return type="void" />
<description>