Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: sdb :: tools ::

unpublished interface XTableAlteration
Base Interfaces
XTableAlterationXConnectionSupplier
   ┗ ::com::sun::star::lang::XInitialization

XConnectionSupplier
(referenced interface's summary:)
allows to access the active connection
Usage Restrictions
not published
Description
allows to alter a table.
Since
OOo 3.3
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

Methods' Summary
alterColumnByName alter the column defined by name  
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.  
dropColumn drops an object of the related container identified by its name.  
Methods' Details
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 );

Description
alter the column defined by name
Parameter table
the table to be altered
Parameter columnName
the name of the column to be changed
Parameter columnDescriptor
the column descriptor with the information of the new column definition
Throws
com::sun::star::sdbc::SQLException
See also
::com::sun::star::sdbcx::XAlterTable
addColumn
void
addColumn( [in] ::com::sun::star::beans::XPropertySet  table,
[in] ::com::sun::star::beans::XPropertySet  descriptor )
raises( ::com::sun::star::sdbc::SQLException );

Description
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.
Parameter table
the table to be altered
Parameter descriptor
the descriptor which should be serve to append a new object
Throws
com::sun::star::sdbc::SQLException if a database access error occurs.
See also
::com::sun::star::sdbcx::XAppend
dropColumn
void
dropColumn( [in] ::com::sun::star::beans::XPropertySet  table,
[in] string  columnName )
raises( ::com::sun::star::sdbc::SQLException );

Description
drops an object of the related container identified by its name.
Parameter table
the table to be altered
Parameter columnName
the name of the column to be dropped
Throws
com::sun::star::sdbc::SQLException if a database access error occurs.
See also
::com::sun::star::sdbcx::XDrop
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.