service Index in module com::sun::star::sdbcx::

(Global Index)

Syntax

service Index;

Description

is used to specify the index for a database table. It refers to one or more columns of a table.

Note: All properties and columns of an index could by modified before they are appended to a table. In that case the service is a data descriptor.

Exported Interfaces

com::sun::star::sdbcx::XDataDescriptorFactory [ OPTIONAL ]

Description

optional, could be used to copy an index.


com::sun::star::sdbcx::XColumnsSupplier

Description

access to the contained index columns.


com::sun::star::beans::XPropertySet

Description

provides information about and access to the properties from an implementation.


Property Summary

Name is the name of the index.

Catalog is the name of the index catalog, may be empty.

IsUnique indicates that the index allow only unique values.

IsPrimaryKeyIndex indicates that the index is used for the primary key.

IsClustered indicates that the index is clustered.

Property Details



Name

Syntax

[readonly] string Name;

Description

is the name of the index.


Catalog

Syntax

[readonly] string Catalog;

Description

is the name of the index catalog, may be empty.


IsUnique

Syntax

[readonly] boolean IsUnique;

Description

indicates that the index allow only unique values.


IsPrimaryKeyIndex

Syntax

[readonly] boolean IsPrimaryKeyIndex;

Description

indicates that the index is used for the primary key.


IsClustered

Syntax

[readonly] boolean IsClustered;

Description

indicates that the index is clustered.

Top of Page