Database Help File


Table of Contents

Database.RemoveColumn
Database.AddColumn
Database.GetColumnName
Database.SetColumnName
Database.Create
Database.Add
Database.UpdateRow
Database.UpdateRowItem
Database.Insert
Database.RemoveRow
Database.CountColumns
Database.CountRows
Database.ReadRow
Database.ReadRowItem
Database.SaveToFile
Database.LoadFromFile
Database.SetDelimiter
Database.GetDelimiter

Database.RemoveColumn


(boolean) Database.RemoveColumn ( 

(tabel) Database,

(number) Column Index )

Description

Removes a column from the database, returns true if OK, else false is returned.

Parameters

Database

(tabel) A handle to a open database.

Column Index

(number) The index of the column you want add to remove from the database.


Return

This action returns a (boolean) value.



Database.AddColumn


(number) Database.AddColumn ( 

(tabel) Database,

(string) Column Name )

Description

Adds a column to the database, returns column index if OK, else -1 is returned.

Parameters

Database

(tabel) A handle to a open database.

Column Name

(string) The name of the column you want add to the database.


Return

This action returns a (number) value.



Database.GetColumnName


(string) Database.GetColumnName ( 

(tabel) Database,

(number) Column Index )

Description

Returns the column name from the given index, if any error a blank string ("") is returned.

Parameters

Database

(tabel) A handle to a open database.

Column Index

(number) The index of the column you want to get the name of.


Return

This action returns a (string) value.



Database.SetColumnName


(boolean) Database.SetColumnName ( 

(tabel) Database,

(number) Column Index,

(string) Column Name )

Description

Sets the column name at the given index, if OK then true is returned else if any error false is returned.

Parameters

Database

(tabel) A handle to a open database.

Column Index

(number) The index of the column you want to rename.

Column Name

(string) The new name for this column.


Return

This action returns a (boolean) value.



Database.Create


(tabel) Database.Create ( 

(string) Column Names )

Description

Creates a database in memory and returns a handle to it.

Parameters

Column Names

(string) A delimited string of the column names, the delimiter MUST be the same as set in Database.SetDelimiter or ("|") is default.


Return

This action returns a (tabel) value.



Database.Add


(number) Database.Add ( 

(tabel) Database,

(string) Values )

Description

Adds a item to the end of the database and returns the index of the new item, if any error (-1) is returned.

Parameters

Database

(tabel) A handle to a open database.

Values

(string) A delimited string of the values to add, the amount of values must match the amount of columns, the delimiter MUST be the same as set in Database.SetDelimiter or ("|") is default.


Return

This action returns a (number) value.



Database.UpdateRow


(boolean) Database.UpdateRow ( 

(tabel) Database,

(string) Values,

(number) Row Index )

Description

Updates/edits a row in the database, the row MUST exists, returns true if ok else returns false.

Parameters

Database

(tabel) A handle to a open database.

Values

(string) A delimited string of the new row values, the amount of values must match the amount of columns, the delimiter MUST be the same as set in Database.SetDelimiter or ("|") is default.

Row Index

(number) The index of the row to update/edit.


Return

This action returns a (boolean) value.



Database.UpdateRowItem


(boolean) Database.UpdateRowItem ( 

(tabel) Database,

(string) Values,

(number) Row Index,

(number) Column Index )

Description

Updates/edits a item in the given row, the row and column MUST exists, returns true if ok else returns false.

Parameters

Database

(tabel) A handle to a open database.

Values

(string) A delimited string of the new row values, the amount of values must match the amount of columns, the delimiter MUST be the same as set in Database.SetDelimiter or ("|") is default.

Row Index

(number) The index of the row to update/edit.

Column Index

(number) The index of the column to update/edit.


Return

This action returns a (boolean) value.



Database.Insert


(number) Database.Insert ( 

(tabel) Database,

(string) Values,

(number) Row Index )

Description

Inserts a item into the database at the given index and returns the new items index, if the index is over the total database count then its added to the end, if any error (-1) is returned.

Parameters

Database

(tabel) A handle to a open database.

Values

(string) A delimited string of the values to add, the amount of values must match the amount of columns, the delimiter MUST be the same as set in Database.SetDelimiter or ("|") is default.

Row Index

(number) The index of the row to insert.


Return

This action returns a (number) value.



Database.RemoveRow


(boolean) Database.RemoveRow ( 

(tabel) Database,

(number) Row Index )

Description

Removes a item from the database, returns true if the item was removed else returns false.

Parameters

Database

(tabel) A handle to a open database.

Row Index

(number) The index of the row to remove.


Return

This action returns a (boolean) value.



Database.CountColumns


(number) Database.CountColumns ( 

(tabel) Database )

Description

Returns the number of columns, if any error (-1) is returned.

Parameters

Database

(tabel) A handle to a open database.


Return

This action returns a (number) value.



Database.CountRows


(number) Database.CountRows ( 

(tabel) Database )

Description

Returns the number of rows, if any error (-1) is returned.

Parameters

Database

(tabel) A handle to a open database.


Return

This action returns a (number) value.



Database.ReadRow


(tabel) Database.ReadRow ( 

(tabel) Database,

(number) Row Index )

Description

Reads a database row and returns a numerically indexed table of the rows contents, the number of table elements will always be equal to the number of columns for that database, if any error a blank string ("") is returned

Parameters

Database

(tabel) A handle to a open database.

Row Index

(number) The index of the row to read.


Return

This action returns a (tabel) value.



Database.ReadRowItem


(string) Database.ReadRowItem ( 

(tabel) Database,

(number) Row Index,

(number) Item Index )

Description

Reads a database row item and returns the value as a string,if any error a blank string ("") is returned

Parameters

Database

(tabel) A handle to a open database.

Row Index

(number) The index of the row to read.

Item Index

(number) The index of the item to read.


Return

This action returns a (string) value.



Database.SaveToFile


(boolean) Database.SaveToFile ( 

(tabel) Database,

(string) Filepath )

Description

Saves a database to file, returns true if ok else false is returned.

Parameters

Database

(tabel) A handle to a open database.

Filepath

(string) The path of the database file


Return

This action returns a (boolean) value.



Database.LoadFromFile


(tabel) Database.LoadFromFile ( 

(string) Filepath )

Description

Loads a database into memory and returns a handle to it.

Parameters

Filepath

(string) The path of the database file


Return

This action returns a (tabel) value.



Database.SetDelimiter


Database.SetDelimiter ( 

(string) Delimiter )

Description

Loads a database into memory and returns a handle to it.

Parameters

Delimiter

(string) Sets the global delimiter of the database.


Return

This action dose not return any value.



Database.GetDelimiter


(string) Database.GetDelimiter ()

Description

Gets the global delimiter of the database.

Parameters

None


Return

This action returns a (string) value.



Made with Action Plugin Compiler