Product Documentation

FairCom DB API for C

Previous Topic

Next Topic

ctdbDropTable

Drop the table from the database.

Declaration

CTDBRET ctdbDropTable(CTHANDLE Handle, pTEXT TableName)

Description

ctdbDropTable() drops the table from the database, but does not delete the table or index files from disk. When a table is dropped, the allocated records, fields, index and segments are freed from memory.

  • Handle [in] the handle of the database that contains the table to be dropped.
  • TableName [in] the name of the table to be dropped.

Note the different syntax from SQL: A SQL Drop Table operation deletes the files from disk, while this function does not. If you wish to delete the files as well, use the ctdbDeleteTable() function. Use ctdbAddTable() to add a table to a database.

Returns

ctdbDropTable() returns CTDBRET_OK on success, or the c-tree error code on failure.

Example


eRet = ctdbConnect(hDatabase, database_name);

eRet = ctdbDropTable(hDatabase, table_name);

See also

ctdbDeleteTable(), ctdbAddTable(), ctdbAllocDatabase()

TOCIndex