awSQL/docs/data/search.json

1 line
14 KiB
JSON

{"list":[{"title":"AlterTable","link":"<a href=\"AlterTable.html\">AlterTable</a>"},{"title":"AlterTable#execute","link":"<a href=\"AlterTable.html#execute\">execute</a>","description":"Executes the prepared querry"},{"title":"AlterTable#selectDatabase","link":"<a href=\"AlterTable.html#selectDatabase\">selectDatabase</a>","description":"Selects a database for this query"},{"title":"AlterTable#structure","link":"<a href=\"AlterTable.html#structure\">structure</a>","description":"The new desired structure.\r- Drops columns that are existing in the current table but not in this structure\r- Adds columns that are missing in the current table\r- Modifies all other columns where at least one datatype is not matching"},{"title":"CheckResult","link":"<a href=\"global.html#CheckResult\">CheckResult</a>"},{"title":"ColumnStructure","link":"<a href=\"global.html#ColumnStructure\">ColumnStructure</a>"},{"title":"ConstraintOptions","link":"<a href=\"global.html#ConstraintOptions\">ConstraintOptions</a>"},{"title":"CreateTable","link":"<a href=\"CreateTable.html\">CreateTable</a>"},{"title":"CreateTable#execute","link":"<a href=\"CreateTable.html#execute\">execute</a>","description":"Executes the prepared querry"},{"title":"CreateTable#name","link":"<a href=\"CreateTable.html#name\">name</a>","description":"Sets a new name"},{"title":"CreateTable#selectDatabase","link":"<a href=\"CreateTable.html#selectDatabase\">selectDatabase</a>","description":"Selects a database for this query"},{"title":"CreateTable#structure","link":"<a href=\"CreateTable.html#structure\">structure</a>","description":"Defines the structure for the table"},{"title":"Delete","link":"<a href=\"Delete.html\">Delete</a>"},{"title":"Delete#execute","link":"<a href=\"Delete.html#execute\">execute</a>","description":"Executes the prepared querry"},{"title":"Delete#force","link":"<a href=\"Delete.html#force\">force</a>","description":"Enables deletion of all rows"},{"title":"Delete#selectDatabase","link":"<a href=\"Delete.html#selectDatabase\">selectDatabase</a>","description":"Selects a database for this query"},{"title":"Delete#where","link":"<a href=\"Delete.html#where\">where</a>","description":"Adds a where-clause to the query\r- Values should be set as ? in the string and given in left-to-right order via the 'values'-array to minimize the risk of sql-injection"},{"title":"Insert","link":"<a href=\"Insert.html\">Insert</a>"},{"title":"Insert#data","link":"<a href=\"Insert.html#data\">data</a>","description":"The data (rows) to insert"},{"title":"Insert#execute","link":"<a href=\"Insert.html#execute\">execute</a>","description":"Executes the prepared querry"},{"title":"Insert#selectDatabase","link":"<a href=\"Insert.html#selectDatabase\">selectDatabase</a>","description":"Selects a database for this query"},{"title":"Instance","link":"<a href=\"Instance.html\">Instance</a>"},{"title":"Instance#alterTable","link":"<a href=\"Instance.html#alterTable\">alterTable</a>","description":"Alters a table and updates to the new given structure."},{"title":"Instance#checkStructure","link":"<a href=\"Instance.html#checkStructure\">checkStructure</a>","description":"Checks the structure of a table"},{"title":"Instance#connect","link":"<a href=\"Instance.html#connect\">connect</a>","description":"Connects the instance"},{"title":"Instance#createDatabase","link":"<a href=\"Instance.html#createDatabase\">createDatabase</a>","description":"Creates a new database\r- Requires admin privileges"},{"title":"Instance#createStructure","link":"<a href=\"Instance.html#createStructure\">createStructure</a>","description":"Prepares to create a new table-structure"},{"title":"Instance#createTable","link":"<a href=\"Instance.html#createTable\">createTable</a>","description":"Prepares to create a new table"},{"title":"Instance#delete","link":"<a href=\"Instance.html#delete\">delete</a>","description":"Prepares a new delete query"},{"title":"Instance#destroy","link":"<a href=\"Instance.html#destroy\">destroy</a>","description":"Destroys the instance"},{"title":"Instance#dropDatabase","link":"<a href=\"Instance.html#dropDatabase\">dropDatabase</a>","description":"Drops a whole database\r- Requires admin privileges"},{"title":"Instance#dropTable","link":"<a href=\"Instance.html#dropTable\">dropTable</a>","description":"Drops a whole table"},{"title":"Instance#getDatabases","link":"<a href=\"Instance.html#getDatabases\">getDatabases</a>","description":"Returns a list of database names the user has access to"},{"title":"Instance#getStructure","link":"<a href=\"Instance.html#getStructure\">getStructure</a>","description":"Returns the structure object of a table"},{"title":"Instance#getTables","link":"<a href=\"Instance.html#getTables\">getTables</a>","description":"Returns a list of tables for the selected database\r- 'multipleStatements' must be active for this to work"},{"title":"Instance#insert","link":"<a href=\"Instance.html#insert\">insert</a>","description":"Prepares a new query to insert data"},{"title":"Instance#isConnected","link":"<a href=\"Instance.html#isConnected\">isConnected</a>","description":"Returns if connection is established"},{"title":"Instance#queryRaw","link":"<a href=\"Instance.html#queryRaw\">queryRaw</a>","description":"Performs a raw query"},{"title":"Instance#select","link":"<a href=\"Instance.html#select\">select</a>","description":"Prepares a new select query"},{"title":"Instance#selectDatabase","link":"<a href=\"Instance.html#selectDatabase\">selectDatabase</a>","description":"Selects a default database for future queries"},{"title":"Instance#total","link":"<a href=\"Instance.html#total\">total</a>","description":"Returns total amount of rows of a table"},{"title":"Instance#update","link":"<a href=\"Instance.html#update\">update</a>","description":"Prepares a new update query"},{"title":"InstanceOptions","link":"<a href=\"global.html#InstanceOptions\">InstanceOptions</a>"},{"title":"Select","link":"<a href=\"Select.html\">Select</a>"},{"title":"Select#avg","link":"<a href=\"Select.html#avg\">avg</a>","description":"Averages numerical rows of the first selected column"},{"title":"Select#count","link":"<a href=\"Select.html#count\">count</a>","description":"Counts number of entries of the first selected column"},{"title":"Select#distinct","link":"<a href=\"Select.html#distinct\">distinct</a>","description":"Adds the 'distinct' keyword for this query\rShould be called on only selected columns.\r- With 'distinct' only unique values are returned"},{"title":"Select#execute","link":"<a href=\"Select.html#execute\">execute</a>","description":"Executes the prepared querry"},{"title":"Select#group","link":"<a href=\"Select.html#group\">group</a>","description":"Groups rows that have the same values into summary rows"},{"title":"Select#having","link":"<a href=\"Select.html#having\">having</a>","description":"Same as a where-clause, but allows for aggregation\r- Values should be set as ? in the string and given in left-to-right order via the 'values'-array to minimize the risk of sql-injection\r- If you are using joins, specify the table and column together: table.column"},{"title":"Select#join","link":"<a href=\"Select.html#join\">join</a>","description":"Adds a new join to the querry"},{"title":"Select#limit","link":"<a href=\"Select.html#limit\">limit</a>","description":"Limits the query and specifies an offset"},{"title":"Select#order","link":"<a href=\"Select.html#order\">order</a>","description":"Adds a new sort order\r- Can be used multiple times to order by multiple columns"},{"title":"Select#pagination","link":"<a href=\"Select.html#pagination\">pagination</a>","description":"Paginates the query"},{"title":"Select#selectDatabase","link":"<a href=\"Select.html#selectDatabase\">selectDatabase</a>","description":"Selects a database for this query"},{"title":"Select#sum","link":"<a href=\"Select.html#sum\">sum</a>","description":"Sums numerical rows of the first selected column"},{"title":"Select#where","link":"<a href=\"Select.html#where\">where</a>","description":"Adds a where-clause to the query\r- Values should be set as ? in the string and given in left-to-right order via the 'values'-array to minimize the risk of sql-injection\r- If you are using joins, specify the table and column together: table.column"},{"title":"Structure","link":"<a href=\"Structure.html\">Structure</a>"},{"title":"Structure#bigint","link":"<a href=\"Structure.html#bigint\">bigint</a>","description":"Adds a new column of data type 'bigint' to this structure"},{"title":"Structure#binary","link":"<a href=\"Structure.html#binary\">binary</a>","description":"Adds a new column of data type 'binary' to this structure"},{"title":"Structure#bit","link":"<a href=\"Structure.html#bit\">bit</a>","description":"Adds a new column of data type 'bit' to this structure"},{"title":"Structure#blob","link":"<a href=\"Structure.html#blob\">blob</a>","description":"Adds a new column of data type 'blob' to this structure"},{"title":"Structure#bool","link":"<a href=\"Structure.html#bool\">bool</a>","description":"Adds a new column of data type 'bool' to this structure"},{"title":"Structure#char","link":"<a href=\"Structure.html#char\">char</a>","description":"Adds a new column of data type 'char' to this structure"},{"title":"Structure#date","link":"<a href=\"Structure.html#date\">date</a>","description":"Adds a new column of data type 'date' to this structure"},{"title":"Structure#datetime","link":"<a href=\"Structure.html#datetime\">datetime</a>","description":"Adds a new column of data type 'datetime' to this structure"},{"title":"Structure#decimal","link":"<a href=\"Structure.html#decimal\">decimal</a>","description":"Adds a new column of data type 'decimal' to this structure"},{"title":"Structure#double","link":"<a href=\"Structure.html#double\">double</a>","description":"Adds a new column of data type 'double' to this structure"},{"title":"Structure#drop","link":"<a href=\"Structure.html#drop\">drop</a>","description":"Drops (Removes) a column name"},{"title":"Structure#enum","link":"<a href=\"Structure.html#enum\">enum</a>","description":"Adds a new column of data type 'enum' to this structure"},{"title":"Structure#float","link":"<a href=\"Structure.html#float\">float</a>","description":"Adds a new column of data type 'float' to this structure"},{"title":"Structure#get","link":"<a href=\"Structure.html#get\">get</a>","description":"Returns the columns"},{"title":"Structure#int","link":"<a href=\"Structure.html#int\">int</a>","description":"Adds a new column of data type 'int' to this structure"},{"title":"Structure#longblob","link":"<a href=\"Structure.html#longblob\">longblob</a>","description":"Adds a new column of data type 'longblob' to this structure"},{"title":"Structure#longtext","link":"<a href=\"Structure.html#longtext\">longtext</a>","description":"Adds a new column of data type 'longtext' to this structure"},{"title":"Structure#mediumint","link":"<a href=\"Structure.html#mediumint\">mediumint</a>","description":"Adds a new column of data type 'mediumint' to this structure"},{"title":"Structure#mediumtext","link":"<a href=\"Structure.html#mediumtext\">mediumtext</a>","description":"Adds a new column of data type 'mediumtext' to this structure"},{"title":"Structure#set","link":"<a href=\"Structure.html#set\">set</a>","description":"Adds a new column of data type 'enum' to this structure"},{"title":"Structure#smallint","link":"<a href=\"Structure.html#smallint\">smallint</a>","description":"Adds a new column of data type 'smallint' to this structure"},{"title":"Structure#text","link":"<a href=\"Structure.html#text\">text</a>","description":"Adds a new column of data type 'text' to this structure"},{"title":"Structure#time","link":"<a href=\"Structure.html#time\">time</a>","description":"Adds a new column of data type 'time' to this structure"},{"title":"Structure#timestamp","link":"<a href=\"Structure.html#timestamp\">timestamp</a>","description":"Adds a new column of data type 'timestamp' to this structure"},{"title":"Structure#tinyblob","link":"<a href=\"Structure.html#tinyblob\">tinyblob</a>","description":"Adds a new column of data type 'tinyblob' to this structure"},{"title":"Structure#tinyint","link":"<a href=\"Structure.html#tinyint\">tinyint</a>","description":"Adds a new column of data type 'tinyint' to this structure"},{"title":"Structure#tinytext","link":"<a href=\"Structure.html#tinytext\">tinytext</a>","description":"Adds a new column of data type 'tinytext' to this structure"},{"title":"Structure#varbinary","link":"<a href=\"Structure.html#varbinary\">varbinary</a>","description":"Adds a new column of data type 'varbinary' to this structure"},{"title":"Structure#varchar","link":"<a href=\"Structure.html#varchar\">varchar</a>","description":"Adds a new column of data type 'varchar' to this structure"},{"title":"Structure#year","link":"<a href=\"Structure.html#year\">year</a>","description":"Adds a new column of data type 'year' to this structure"},{"title":"Update","link":"<a href=\"Update.html\">Update</a>"},{"title":"Update#data","link":"<a href=\"Update.html#data\">data</a>","description":"Updates all matching rows with the given object"},{"title":"Update#execute","link":"<a href=\"Update.html#execute\">execute</a>","description":"Executes the prepared querry"},{"title":"Update#force","link":"<a href=\"Update.html#force\">force</a>","description":"Enables update of all rows"},{"title":"Update#selectDatabase","link":"<a href=\"Update.html#selectDatabase\">selectDatabase</a>","description":"Selects a database for this query"},{"title":"Update#where","link":"<a href=\"Update.html#where\">where</a>","description":"Adds a where-clause to the query\r- Values should be set as ? in the string and given in left-to-right order via the 'values'-array to minimize the risk of sql-injection"},{"title":"awSQL","link":"<a href=\"awSQL.html\">awSQL</a>"},{"title":"awSQL#createInstance","link":"<a href=\"awSQL.html#createInstance\">createInstance</a>","description":"Creates a new instance (database connection)"},{"title":"awSQL#deleteInstance","link":"<a href=\"awSQL.html#deleteInstance\">deleteInstance</a>","description":"Deletes an instance (and closes any open connection)"},{"title":"awSQL#getInstance","link":"<a href=\"awSQL.html#getInstance\">getInstance</a>","description":"Returns an instance matching the given identifier\r\rReturns default (or first) instance if no identifier is given"},{"title":"awSQL#listInstances","link":"<a href=\"awSQL.html#listInstances\">listInstances</a>","description":"Returns a list of the identifiers of all instances"}]}