Home | Previous Page | Next Page   Descriptor Function Reference > Accessor Functions >

mi_tab_spacename()

The mi_tab_spacename() function retrieves the name of the storage space where the virtual index resides.

Syntax

mi_string* mi_tab_spacename(MI_AM_TABLE_DESC *tableDesc)
tableDesc
points to the index descriptor.

Usage

Call the mi_tab_spacename() function to determine the storage space identifier from one of the following sources:

IN Clause

When a user creates an index, the CREATE INDEX statement can include an IN clause that specifies one of the following:

For example, the mi_tab_spacename() function returns the string dc39 for a storage space that the following commands specify:

onspaces -c -x dc39 -l "host=dcserver,port=39"
CREATE INDEX idx_remote on TABLE remote...
   IN dc39
   USING access_method

The statement that creates the index can specify the physical storage location rather than a logical name that the onspaces utility associates with the storage space. In the following UNIX example, mi_tab_spacename() returns the physical path, /tmp:

CREATE INDEX idx_remote on TABLE remote...
   IN '/tmp'
   USING access_method

If the IN clause specifies multiple storage spaces, each makes up a fragment of the index and the table descriptor pertains to only the fragment that the return value for the mi_tab_spacename() function names.

SBSPACENAME Value

An optional SBSPACENAME parameter in the ONCONFIG file indicates the name of an existing sbspace as the default location to create a new smart large object or virtual index. The database server assigns the default sbspace to a virtual index under the following circumstances:

For more information, refer to Creating a Default Storage Space.

Return Values

A string identifies the sbspace or extspace that the CREATE INDEX statement associates with the index. A NULL-valued pointer indicates that the index does not reside in a named storage space.

Home | [ Top of Page | Previous Page | Next Page | Contents | Index ]