![]() |
T4S4
19.1 C8540 A23673
Teamcenter Gateway for SAP S/4HANA API Reference
|
Namespaces | |
API::Core::Sql | |
SQLlite interface to the internal T4x database. | |
Functions | |
begin databaseRef | |
Marks the begin of a database transaction. More... | |
commit databaseRef | |
Marks the completion of a database transaction as successful. More... | |
connect databaseRef databaseFileName | |
Opens a connection with a database. More... | |
createIndex databaseRef indexName tableName columnNameList args | |
Creates an index. More... | |
createTable databaseRef tableName columnNameTypeList args | |
Creates a table. More... | |
delete databaseRef tableName whereCondition | |
Deletes one or more rows from a table. More... | |
deleteIndex databaseRef indexName | |
Deletes an index. More... | |
deleteTable databaseRef tableName | |
Deletes a table. More... | |
disconnect databaseRef | |
Closes a connection with a database. More... | |
executeSql databaseRef sqlStatement | |
Executes an SQL statement. More... | |
explainSql databaseRef sqlStatement | |
Retrieves the execution plan of an SQL statement without executing the statement. More... | |
export databaseRef tableName filePath | |
Exports the content of a table to a CSV (tab-separated) file. More... | |
getIndexInfo databaseRef indexName | |
Retrieves meta information about an index. More... | |
getIndexInfoList databaseRef | |
Retrieves meta information about all indexes in the database. More... | |
getShowSql | |
Tells, if SQL statements are shown. More... | |
getTableInfo databaseRef tableName | |
Retrieves meta information about a table. More... | |
getTableInfoList databaseRef | |
Retrieves meta information about all tables in the database. More... | |
import databaseRef tableName filePath | |
Imports the content of a CSV (tab-separated) file to a table. More... | |
insert databaseRef tableName columnValueList | |
Inserts a row into a table. More... | |
optimizeSpace databaseRef | |
Optimizes the database with respect to space. More... | |
optimizeTime databaseRef | |
Optimizes the database with respect to time. More... | |
rollback databaseRef | |
Marks the completion of a database transaction as not successful. More... | |
select databaseRef columnNameList tableNameList whereCondition args | |
Retrieves one or more rows of one or more tables. More... | |
setShowSql showSql | |
Changes, if SQL statements are shown. More... | |
update databaseRef tableName columnNameValueList whereCondition | |
Updates one or more rows of a table. More... | |
API::Core::Sql::begin | databaseRef | ||
Marks the begin of a database transaction.
Transactions may be nested
databaseRef | a reference to a variable name representing the database |
API::Core::Sql::commit | databaseRef | ||
Marks the completion of a database transaction as successful.
In case there is no transaction nesting, the effects of the transaction are made permanent. In case there is transaction nesting, the outermost transaction commits successfully if and only if all transactions including the subtransactions commit successfully. In this case the effects of all transactions are made permanent
databaseRef | a reference to a variable name representing the database |
API::Core::Sql::connect | databaseRef databaseFileName | ||
Opens a connection with a database.
databaseRef | a reference to a variable name representing the database |
databaseFileName | the file name of the database file |
API::Core::Sql::createIndex | databaseRef indexName tableName columnNameList args | ||
Creates an index.
databaseRef | a reference to a variable name representing the database |
indexName | the index name |
tableName | the table name |
columnNameList | a list of column names, e.g [list b c] |
args | (optional) constraints
|
API::Core::Sql::createTable | databaseRef tableName columnNameTypeList args | ||
Creates a table.
databaseRef | a reference to a variable name representing the database |
tableName | the table name |
columnNameTypeList | a list of column names and types, e.g. [list a integer b text c "text|unique|not null" d integer] |
args | (optional) constraints
|
API::Core::Sql::delete | databaseRef tableName whereCondition | ||
Deletes one or more rows from a table.
databaseRef | a reference to a variable name representing the database |
tableName | the table name |
whereCondition | a condition specifying which rows to delete |
API::Core::Sql::deleteIndex | databaseRef indexName | ||
Deletes an index.
databaseRef | a reference to a variable name representing the database |
indexName | the index name |
API::Core::Sql::deleteTable | databaseRef tableName | ||
Deletes a table.
databaseRef | a reference to a variable name representing the database |
tableName | the table name |
API::Core::Sql::disconnect | databaseRef | ||
Closes a connection with a database.
databaseRef | a reference to a variable name representing the database |
API::Core::Sql::executeSql | databaseRef sqlStatement | ||
Executes an SQL statement.
databaseRef | a reference to a variable name representing the database |
sqlStatement | the SQL statement |
API::Core::Sql::explainSql | databaseRef sqlStatement | ||
Retrieves the execution plan of an SQL statement without executing the statement.
databaseRef | a reference to a variable name representing the database |
sqlStatement | the SQL statement |
API::Core::Sql::export | databaseRef tableName filePath | ||
Exports the content of a table to a CSV (tab-separated) file.
If the file does not exist, the file is created; otherwise, the file is overwritten.
databaseRef | a reference to a variable name representing the database |
tableName | the name of the table |
filePath | the file path of the file |
API::Core::Sql::getIndexInfo | databaseRef indexName | ||
Retrieves meta information about an index.
databaseRef | a reference to a variable name representing the database |
indexName | the index name |
API::Core::Sql::getIndexInfoList | databaseRef | ||
Retrieves meta information about all indexes in the database.
databaseRef | a reference to a variable name representing the database |
API::Core::Sql::getShowSql |
Tells, if SQL statements are shown.
API::Core::Sql::getTableInfo | databaseRef tableName | ||
Retrieves meta information about a table.
databaseRef | a reference to a variable name representing the database |
tableName | the table name |
API::Core::Sql::getTableInfoList | databaseRef | ||
Retrieves meta information about all tables in the database.
databaseRef | a reference to a variable name representing the database |
API::Core::Sql::import | databaseRef tableName filePath | ||
Imports the content of a CSV (tab-separated) file to a table.
If the table does not exist, an error is raised
databaseRef | a reference to a variable name representing the database |
tableName | the name of the table |
filePath | the file path of the file |
API::Core::Sql::insert | databaseRef tableName columnValueList | ||
Inserts a row into a table.
databaseRef | a reference to a variable name representing the database |
tableName | the table name |
columnValueList | a list of column values, e.g [list NULL 1 "'new string value'"] |
API::Core::Sql::optimizeSpace | databaseRef | ||
Optimizes the database with respect to space.
databaseRef | a reference to a variable name representing the database |
API::Core::Sql::optimizeTime | databaseRef | ||
Optimizes the database with respect to time.
databaseRef | a reference to a variable name representing the database |
API::Core::Sql::rollback | databaseRef | ||
Marks the completion of a database transaction as not successful.
In case there is no transaction nesting, the effects of the transaction are made undone. In case there is transaction nesting, the outermost transaction rolls back successfully if and only if any transaction including the subtransactions rolls back successfully. In this case the effects of all transactions are made undone
databaseRef | a reference to a variable name representing the database |
API::Core::Sql::select | databaseRef columnNameList tableNameList whereCondition args | ||
Retrieves one or more rows of one or more tables.
databaseRef | a reference to a variable name representing the database |
columnNameList | a list of column names, e.g. [list tab1.a tab1.b tab2.a tab2.c] |
tableNameList | a list of table names, e.g. [list tab1 tab2] |
whereCondition | a condition specifying which rows to retrieve |
args | (optional) additional arguments
|
API::Core::Sql::setShowSql | showSql | ||
Changes, if SQL statements are shown.
showSql | if SQL statements are shown: 1 = "yes", 0 = "no" |
API::Core::Sql::update | databaseRef tableName columnNameValueList whereCondition | ||
Updates one or more rows of a table.
databaseRef | a reference to a variable name representing the database |
tableName | the table name |
columnNameValueList | a list of column names and values, e.g [list a 100 b 'luck'] |
whereCondition | a condition specifying which rows to update |