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

(Global Index)

Syntax

service Column;

Description

describes the common properties of a database column.

Exported Interfaces

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

Description

optional, could be used to copy a database column.


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 column.

Type is the DataType of the column.

TypeName is the type name used by the database. If the column type is a user-defined type, then a fully-qualified type name is returned. Note: May be empty.

Precision gets a column's number of decimal digits.

Scale gets a column's number of digits to right of the decimal point.

IsNullable indicates the nullability of values in the designated column.

IsAutoIncrement indicates whether the column is automatically numbered, thus read-only.

IsCurrency indicates whether the column is a cash value.

IsRowVersion indicates that the column contains some kind of time or date stamp used to track updates. @optional

Description keeps a description of the object. @optional

DefaultValue keeps a default value for a column, is provided as string. @optional

Property Details



Name

Syntax

[readonly] string Name;

Description

is the name of the column.


Type

Syntax

[readonly] long Type;

Description

is the DataType of the column.


TypeName

Syntax

[readonly] string TypeName;

Description

is the type name used by the database. If the column type is a user-defined type, then a fully-qualified type name is returned. Note: May be empty.


Precision

Syntax

[readonly] long Precision;

Description

gets a column's number of decimal digits.


Scale

Syntax

[readonly] long Scale;

Description

gets a column's number of digits to right of the decimal point.


IsNullable

Syntax

[readonly] long IsNullable;

Description

indicates the nullability of values in the designated column.

See also

ColumnValue

IsAutoIncrement

Syntax

[readonly] boolean IsAutoIncrement;

Description

indicates whether the column is automatically numbered, thus read-only.

See also

ColumnValue

IsCurrency

Syntax

[readonly] boolean IsCurrency;

Description

indicates whether the column is a cash value.


IsRowVersion [ O P T I O N A L ]

Syntax

[readonly] boolean IsRowVersion;

Description

indicates that the column contains some kind of time or date stamp used to track updates. @optional


Description [ O P T I O N A L ]

Syntax

[readonly] string Description;

Description

keeps a description of the object. @optional


DefaultValue [ O P T I O N A L ]

Syntax

[readonly] string DefaultValue;

Description

keeps a default value for a column, is provided as string. @optional

Top of Page