oracle.javatools.db.ora

Class LOBDescriptor

java.lang.Object

oracle.javatools.db.AbstractDBObject

oracle.javatools.db.AbstractChildDBObject

oracle.javatools.db.ora.LOBDescriptor

All Implemented Interfaces:

ChildDBObject, DBObject, Copyable

public class LOBDescriptor
extends AbstractChildDBObject

LOBDescriptor encapsulates the partitioning properties of LOB and VARRAY columns. One or more LOBDescriptor objects are held on a TablePartition object. For an overview of the table partitioning api, see OracleTablePartitions.
LOBDescriptors may be defined for an individual partition, partition level subpartition or subpartition template, although only the properties are restricted for subpartitions and hash partitions.
The following DDL shows LOB and VARRAY column definitions within a partition, partition level subpartition and subpartition template :

   create table RANGE_LIST1
    ( C1 number
    , C2 number
    , C_CLOB clob
    , C_BLOB blob
    , C_VARRAY T_VARRAY
    )
    partition by range(C1)
    subpartition by list(C2) subpartition template
      (
        subpartition RANGE_LIST1_SP1
        lob(C_CLOB) store as RANGE_LIST1_SP1_SEG1(tablespace EXAMPLE)
      )
    ( partition P100 less than(100)
        lob(C_BLOB, C_CLOB) store as (cache reads nologging)
        lob(C_VARRAY) store as RANGE_LIST1_P100_SEG1(storage(freelist groups 5) nocache)
        ( subpartition RANGE_LIST1_P100_SP1
            lob(C_CLOB) store as RANGE_LIST1_P100_SP1_SEG1(tablespace USERS)
         ,subpartition RANGE_LIST1_P100_SP2
            varray C_VARRAY store as RANGE_LIST1_P100_SP2_SEG1
        )
    )
 

A LOBDescriptor defines :

1. LOB_SEGNAME : an optional lob segment name (also known as lob partition name).
2. COLUMNS : When LOB_SEGNAME is specified, a single LOB or VARRAY column. When LOB_SEGNAME is null, a single VARRAY column or one or more LOB columns.
3. STORAGE_ENABLED_IN_ROW : a boolean.
4. CHUNK : optional integer between 1 and min( next_extent, 32768 ).
5. PCTVERSION : optional integer between 0 and 100.
6. RETENTION : a boolean.
7. FREEPOOLS : optional positive integer.
8. CACHE : optional {"CACHE", "NOCACHE", "CACHE READS"}
9. STORAGE : an optional reference to an OracleStorageProperties object. When a LOBDescriptor is defining a LOB or VARRAY column in a list or range partiton, all OracleStorageProperties may be specified except for PCTFREE, PCTUSED, INITRANS and MAXTRANS. When a LOBDescriptor is defining a LOB or VARRAY column in a subpartition or hash partition, only TABLESPACE is valid.

When a LOBDescriptor is defining a LOB or VARRAY column in a subpartition or hash partition the only valid properties are LOB_SEGNAME, COLUMNS, and STORAGE.TABLESPACE.

In the following DDL clauses properties STORAGE_ENABLED_IN_ROW to STORAGE are designated LOB_PARAMETERS.
DDL clauses for LOB and VARRAY columns of a range or list partition

1. lob(COLUMNS) store as (LOB_PARAMETERS)
2. lob(COLUMNS) store as LOB_SEGNAME [(LOB_PARAMETERS)]
3. varray COLUMNS store as (LOB_PARAMETERS)
4. varray COLUMNS store as LOB_SEGNAME [(LOB_PARAMETERS)]

DDL clauses for LOB and VARRAY columns of a subpartiton or hash partition

1. lob(COLUMNS) store as (tablespace STORAGE.TABLESPACE)
2. lob(COLUMNS) store as LOB_SEGNAME [(tablespace STORAGE.TABLESPACE)]
3. varray COLUMNS store as LOB_SEGNAME

Since:

11.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LOBDescriptor.LOBCache The CACHE clauses indicates how Oracle Database should store blocks in the buffer cache.

Nested classes/interfaces inherited from class oracle.javatools.db.AbstractDBObject

AbstractDBObject.ChildSupport, AbstractDBObject.ListenerSupport

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LOB_PARAMETER_CACHE Deprecated. replaced by LOBDescriptor.LOBCache.CACHE.
static java.lang.String	LOB_PARAMETER_CACHEREADS Deprecated. replaced by LOBDescriptor.LOBCache.CACHE_READS.
static java.lang.String	LOB_PARAMETER_NOCACHE Deprecated. replaced by LOBDescriptor.LOBCache.CACHE.
static java.lang.String	TYPE

Fields inherited from interface oracle.javatools.db.DBObject

COMMENT

Constructor Summary

Constructors

Constructor and Description
LOBDescriptor()

Method Summary

Modifier and Type	Method and Description
void	addColumn(DBObjectID column) Add a column to the column list.
java.lang.String	getCache() Deprecated. - Use getLOBCache()
java.lang.Integer	getChunk() Return the value of CHUNK.
DBObjectID[]	getColumns()
java.lang.Integer	getFreepools() Return the value of FREEPOOLS
LOBDescriptor.LOBCache	getLOBCache() Gets the LOB cache value (can be null).
java.lang.String	getLOBSegName() Gets the segment name for this LOB.
java.lang.String	getName() Retrieves the name of this object.
java.lang.Integer	getPctVersion() Return the value of PCTVERSION.
OracleStorageProperties	getStorage()
java.lang.Boolean	getStorageInRow() Gets whether the storage of the lob is: true = in the table row (inline) false = outside the table row (out-of-line) null = not specified
java.lang.String	getType() Returns the type of this object.
static boolean	isLOBColumn(Column column) Tests whether the given Column's datatype is a LOB type.
static boolean	isLOBColumn(DBObjectID colID) Deprecated. use isLOBColumn(DBObjectID,DBObject) - resolving IDs is unnecessary.
static boolean	isLOBColumn(DBObjectID colID, DBObject context) Tests whether the datatype for the Column with the given ID is a LOB type.
static boolean	isLOBType(DataType type) Checks whether the given DataType is a LOB type, and can therefore have LOB properties defined.
boolean	isRetention()
boolean	isStorageEnabledInRow() Deprecated. use getStorageInRow()
static boolean	isVARRAYColumn(Column column) Tests whether the given Column's datatype is a VARRAY type.
static boolean	isVARRAYColumn(DBObjectID colID) Deprecated. use isVARRAYColumn(DBObjectID,DBObject) - resolving IDs is unnecessary.
static boolean	isVARRAYColumn(DBObjectID colID, DBObject context) Tests whether the datatype for the Column with the given ID is a VARRAY type.
static boolean	isVARRAYType(DataType type) Tests whether the given DataType is a VARRAY Type.
void	removeColumn(DBObjectID column) Remove a column from the column list.
void	setCache(java.lang.String cache) Deprecated. - Use setLOBCache(oracle.javatools.db.ora.LOBDescriptor.LOBCache)
void	setChunk(java.lang.Integer chunk) Set the value of CHUNK.
void	setColumns(DBObjectID[] columns) Replace the column list.
void	setFreepools(java.lang.Integer freepools) Set the value of FREEPOOLS.
void	setLOBCache(LOBDescriptor.LOBCache cache) Sets the LOB cache value.
void	setLOBSegName(java.lang.String name) Sets the name of the segment for this LOB.
void	setPctVersion(java.lang.Integer pctVersion) Set the value of PCTVERSION.
void	setRetention(boolean retention)
void	setStorage(OracleStorageProperties storage)
void	setStorageEnabledInRow(boolean storageEnabledInRow) Deprecated. use setStorageInRow(Boolean)
void	setStorageInRow(java.lang.Boolean storageInRow) Sets whether the storage of the lob is in the table row.

Methods inherited from class oracle.javatools.db.AbstractChildDBObject

setParent

Methods inherited from class oracle.javatools.db.AbstractDBObject

addObjectListener, addObjectListener, addObjectListener, changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyTo, copyToImpl, equals, equalsImpl, findOwnedObject, findOwnedObject, findOwnedObject, findOwnedObject, findParent, fireObjectUpdated, firePropertyChanged, getChildSupport, getChildSupport, getID, getOwnedObjects, getOwnedObjects, getOwnedObjectsImpl, getParent, getProperties, getProperty, getProperty, getReferenceIDs, getReferenceIDsImpl, hashCode, includeOwnedObject, includesType, includesType, removeObjectListener, removeObjectListener, removeObjectListener, removeOwnedObject, removeThisAsParent, replaceReferenceIDs, setID, setName, setProperties, setProperty, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.javatools.db.ChildDBObject

getParent

Methods inherited from interface oracle.javatools.db.DBObject

addObjectListener, copyTo, copyTo, copyTo, equals, findOwnedObject, findOwnedObject, findOwnedObject, getID, getOwnedObjects, getOwnedObjects, getProperties, getProperty, getProperty, getReferenceIDs, hashCode, removeObjectListener, removeOwnedObject, replaceReferenceIDs, setID, setName, setProperties, setProperty

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

LOB_PARAMETER_CACHE

@Deprecated
public static final java.lang.String LOB_PARAMETER_CACHE

Deprecated. replaced by LOBDescriptor.LOBCache.CACHE.

LOB_PARAMETER_NOCACHE

@Deprecated
public static final java.lang.String LOB_PARAMETER_NOCACHE

Deprecated. replaced by LOBDescriptor.LOBCache.CACHE.

LOB_PARAMETER_CACHEREADS

@Deprecated
public static final java.lang.String LOB_PARAMETER_CACHEREADS

Deprecated. replaced by LOBDescriptor.LOBCache.CACHE_READS.

Constructor Detail

LOBDescriptor

public LOBDescriptor()

Method Detail

getName

public java.lang.String getName()

Description copied from interface: DBObject

Retrieves the name of this object.

Specified by:

getName in interface DBObject

Overrides:

getName in class AbstractDBObject

Returns:

a string containing the name of this object.

getType

public java.lang.String getType()

Description copied from interface: DBObject

Returns the type of this object. Valid types include things like tables, views, synonyms, and columns.

Returns:

a string describing the type of object.

setLOBSegName

public void setLOBSegName(java.lang.String name)

Sets the name of the segment for this LOB.

Parameters:

name - the internal name for the LOB segment

getLOBSegName

public java.lang.String getLOBSegName()

Gets the segment name for this LOB. If the name is not specified there must be only one column.

Returns:

the log segment name in internal form, or null if not specified.

setColumns

public void setColumns(DBObjectID[] columns)

Replace the column list. When LOB_SEGNAME is specified, only a single LOB or VARRAY column is allowed. When LOB_SEGNAME is null, a single VARRAY column or one or more LOB columns is allowed.

Parameters:

columns -

getColumns

public DBObjectID[] getColumns()

addColumn

public void addColumn(DBObjectID column)

Add a column to the column list. When LOB_SEGNAME is specified, only a single LOB or VARRAY column is allowed. When LOB_SEGNAME is null, a single VARRAY column or one or more LOB columns is allowed.

Parameters:

column -

removeColumn

public void removeColumn(DBObjectID column)

Remove a column from the column list.

Parameters:

column -

setChunk

public void setChunk(java.lang.Integer chunk)

Set the value of CHUNK.

Parameters:

chunk - : null or an integer between 1 and min( next_extent, 32768 ).

getChunk

public java.lang.Integer getChunk()

Return the value of CHUNK.

Returns:

null or an integer between 1 and min( next_extent, 32768 ).

setPctVersion

public void setPctVersion(java.lang.Integer pctVersion)

Set the value of PCTVERSION.

Parameters:

pctVersion - : null or an integer between 0 and 100

getPctVersion

public java.lang.Integer getPctVersion()

Return the value of PCTVERSION.

Returns:

null or an integer between 0 and 100

setFreepools

public void setFreepools(java.lang.Integer freepools)

Set the value of FREEPOOLS. Only one of FREEPOOLS and STORAGE(FREELIST GROUPS) may be specified.

Parameters:

freepools - : null or a positive integer

getFreepools

public java.lang.Integer getFreepools()

Return the value of FREEPOOLS

Returns:

null or a positive integer

setStorage

public void setStorage(OracleStorageProperties storage)

getStorage

public OracleStorageProperties getStorage()

setRetention

public void setRetention(boolean retention)

isRetention

public boolean isRetention()

setStorageEnabledInRow

@Deprecated
public void setStorageEnabledInRow(boolean storageEnabledInRow)

Deprecated. use setStorageInRow(Boolean)

isStorageEnabledInRow

@Deprecated
public boolean isStorageEnabledInRow()

Deprecated. use getStorageInRow()

setStorageInRow

public void setStorageInRow(java.lang.Boolean storageInRow)

Sets whether the storage of the lob is in the table row.

Parameters:

whether - the lob is to be stored in the table row

getStorageInRow

public java.lang.Boolean getStorageInRow()

Gets whether the storage of the lob is:

• true = in the table row (inline)
• false = outside the table row (out-of-line)
• null = not specified

Returns:

whether the storage is enabled in row

setCache

@Deprecated
public void setCache(java.lang.String cache)

Deprecated. - Use setLOBCache(oracle.javatools.db.ora.LOBDescriptor.LOBCache)

Set the value of CACHE

getCache

@Deprecated
public java.lang.String getCache()

Deprecated. - Use getLOBCache()

return the value of CACHE

setLOBCache

public void setLOBCache(LOBDescriptor.LOBCache cache)

Sets the LOB cache value. Must be null, LOBCache.CACHE, LOBCache.CACHE or LOBCache.CACHE_READS

getLOBCache

public LOBDescriptor.LOBCache getLOBCache()

Gets the LOB cache value (can be null).

isLOBColumn

@Deprecated
public static boolean isLOBColumn(DBObjectID colID)

Deprecated. use isLOBColumn(DBObjectID,DBObject) - resolving IDs is unnecessary.

See Also:

isLOBColumn(DBObjectID,DBObject)

isLOBColumn

public static boolean isLOBColumn(DBObjectID colID,
                                  DBObject context)

Tests whether the datatype for the Column with the given ID is a LOB type.

Parameters:

the - id of the column to test

context - the context object for the search, this must be a child of the same Table that the Column is on for the lookup to work.

Returns:

true if the column's datatype is a LOB type

See Also:

isLOBColumn(Column)

isLOBColumn

public static boolean isLOBColumn(Column column)

Tests whether the given Column's datatype is a LOB type. Note - resolving the type can hit the db, use isLOBType(oracle.javatools.db.datatypes.DataType) directly if you already have the DataType.

Parameters:

the - column to test

Returns:

true if the column's datatype is a LOB type

See Also:

isLOBType(oracle.javatools.db.datatypes.DataType)

isLOBType

public static boolean isLOBType(DataType type)

Checks whether the given DataType is a LOB type, and can therefore have LOB properties defined.

Parameters:

type - the type to test

Returns:

true if the type is a LOB type

isVARRAYColumn

@Deprecated
public static boolean isVARRAYColumn(DBObjectID colID)

Deprecated. use isVARRAYColumn(DBObjectID,DBObject) - resolving IDs is unnecessary.

See Also:

isVARRAYColumn(DBObjectID,DBObject)

isVARRAYColumn

public static boolean isVARRAYColumn(DBObjectID colID,
                                     DBObject context)

Tests whether the datatype for the Column with the given ID is a VARRAY type.

Parameters:

the - id of the column to test

context - the context object for the search, this must be a child of the same Table that the Column is on for the lookup to work.

Returns:

true if the column's datatype is a VARRAY type

See Also:

isVARRAYColumn(Column)

isVARRAYColumn

public static boolean isVARRAYColumn(Column column)

Tests whether the given Column's datatype is a VARRAY type. Note - resolving the type can hit the db, use isVARRAYType(oracle.javatools.db.datatypes.DataType) directly if you already have the DataType.

Parameters:

the - column to test

Returns:

true if the column's datatype is resolvable to a VARRAY type

See Also:

isVARRAYType(oracle.javatools.db.datatypes.DataType)

isVARRAYType

public static boolean isVARRAYType(DataType type)

Tests whether the given DataType is a VARRAY Type.

Parameters:

type - the type to test

Returns:

true if the type is a VARRAY type