LibreOffice
LibreOffice 24.2 SDK API Reference
Exported Interfaces | Public Member Functions | List of all members
XTableAlteration Interface Reference

allows to alter a table. More...

import"XTableAlteration.idl";

Inheritance diagram for XTableAlteration:
XConnectionSupplier XInitialization XInterface

Exported Interfaces

interface XConnectionSupplier
 
- Exported Interfaces inherited from XConnectionSupplier
interface com::sun::star::lang::XInitialization
 

Public Member Functions

void alterColumnByName ([in] com::sun::star::beans::XPropertySet table, [in] string columnName, [in] com::sun::star::beans::XPropertySet columnDescriptor) raises ( com::sun::star::sdbc::SQLException )
 alter the column defined by name More...
 
void addColumn ([in] com::sun::star::beans::XPropertySet table, [in]com::sun::star::beans::XPropertySet descriptor) raises (com::sun::star::sdbc::SQLException)
 creates a new object using the given descriptor and appends it to the related container. More...
 
void dropColumn ([in] com::sun::star::beans::XPropertySet table, [in]string columnName) raises ( com::sun::star::sdbc::SQLException)
 drops an object of the related container identified by its name. More...
 
- Public Member Functions inherited from XInitialization
void initialize ([in] sequence< any > aArguments) raises ( com::sun::star::uno::Exception )
 initializes the object. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Additional Inherited Members

- Public Attributes inherited from XConnectionSupplier
com::sun::star::sdbc::XConnection ActiveConnection
 returns the source connection. More...
 

Detailed Description

allows to alter a table.

See also
com::sun::star::sdb::DataSource::Settings
com::sun::star::sdbcx::ColumnDescriptor
com::sun::star::sdbcx::XAlterTable
com::sun::star::sdbcx::XAppend
com::sun::star::sdbcx::XDrop
Since
OOo 3.3

Exported Interfaces

◆ XConnectionSupplier

Member Function Documentation

◆ addColumn()

creates a new object using the given descriptor and appends it to the related container.

Note: The descriptor will not be changed and can be used again to append another object.

Parameters
tablethe table to be altered
descriptorthe descriptor which should be serve to append a new object
Exceptions
com::sun::star::sdbc::SQLExceptionif a database access error occurs.
See also
com::sun::star::sdbcx::XAppend

◆ alterColumnByName()

void alterColumnByName ( [in] com::sun::star::beans::XPropertySet  table,
[in] string  columnName,
[in] com::sun::star::beans::XPropertySet  columnDescriptor 
)
raises (com::sun::star::sdbc::SQLException
)

alter the column defined by name

Parameters
tablethe table to be altered
columnNamethe name of the column to be changed
columnDescriptorthe column descriptor with the information of the new column definition
Exceptions
com::sun::star::sdbc::SQLException
See also
com::sun::star::sdbcx::XAlterTable

◆ dropColumn()

void dropColumn ( [in] com::sun::star::beans::XPropertySet  table,
[in] string  columnName 
)
raises (com::sun::star::sdbc::SQLException
)

drops an object of the related container identified by its name.

Parameters
tablethe table to be altered
columnNamethe name of the column to be dropped
Exceptions
com::sun::star::sdbc::SQLExceptionif a database access error occurs.
See also
com::sun::star::sdbcx::XDrop

The documentation for this interface was generated from the following file: