oracle.javatools.db.ora

Class OracleExternalTableProperties

java.lang.Object

oracle.javatools.db.AbstractDBObject

oracle.javatools.db.AbstractBuildableObject

oracle.javatools.db.AbstractChildBuildableObject

oracle.javatools.db.ora.OracleExternalTableProperties

All Implemented Interfaces:

ChildDBObject, DBObject, Copyable

public class OracleExternalTableProperties
extends AbstractChildBuildableObject

This object represents the "external table clause" syntax for creating an external table. An external table is one whose metadata (definition) is stored in the database, but whose data is stored outside the database.

• An external table cannot be a temporary table.
• You cannot specify constraints on an external table.
• An external table cannot have object type, varray, or LONG columns. However, you can populate LOB columns of an external table with varray or LONG data from an internal database table.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OracleExternalTableProperties.AccessType Allowed values for the access parameter type.
static class	OracleExternalTableProperties.LocationSpecifier The LOCATION clause lets you specify one or more external data sources.
static class	OracleExternalTableProperties.ProjectColumn

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	ACCESS_DRIVER_TYPE_ORACLE_BIGDATA Access driver type ORACLE_BIGDATA.
static java.lang.String	ACCESS_DRIVER_TYPE_ORACLE_DATAPUMP Access driver type ORACLE_DATAPUMP.
static java.lang.String	ACCESS_DRIVER_TYPE_ORACLE_HDFS Access driver type ORACLE_HDFS.
static java.lang.String	ACCESS_DRIVER_TYPE_ORACLE_HIVE Access driver type ORACLE_HIVE.
static java.lang.String	ACCESS_DRIVER_TYPE_ORACLE_LOADER Access driver type ORACLE_LOADER.
static java.lang.String	KEY KEY for use in getProperty/setProperty on a Table object to query the external table properties.
static int	REJECT_LIMIT_UNLIMITED Value for the rejectLimit property that represents "UNLIMITED".
static java.lang.String	TYPE

Fields inherited from interface oracle.javatools.db.DBObject

COMMENT

Constructor Summary

Constructors

Constructor and Description
OracleExternalTableProperties() Creates an empty OracleExternalTableProperties object, which is used to define the properties of an external table.

Method Summary

Modifier and Type	Method and Description
void	addLocationSpecifier(DBObjectID directory, java.lang.String specifier) Adds a location specifier that uses the given Directory (by ID) and the specified location.
void	addLocationSpecifier(OracleExternalTableProperties.LocationSpecifier locationSpecifier) Adds the given location specifier.
void	addLocationSpecifier(java.lang.String specifier) Adds a location specifier that uses the given Directory (by ID) and the specified location.
java.lang.String	getAccessDriverType() Get the access driver type.
java.lang.String	getAccessParameters() Get the access driver's parameters.
SQLFragment	getAccessParametersFragment() Gets the driver's access parameters derived as a SQLFragment.
DBObjectID	getDefaultDirectory() Gets the default Directory by ID.
OracleExternalTableProperties.LocationSpecifier[]	getLocationSpecifiers() Gets the LocationSpecifiers which are used to specify the external locations used to store the table's data.
OracleExternalTableProperties.ProjectColumn	getProjectColumn() Get the value of the 'alter table project column clause'.
java.lang.Integer	getRejectLimit() Gets the reject limit for the external table.
java.lang.String	getType() Returns the type of this object.
boolean	isAccessUsingClob() Gets whether the access parameters are defined using a clob subquery.
void	removeAllLocationSpecifiers() Clears the list of LocationSpecifiers.
void	removeLocationSpecifier(OracleExternalTableProperties.LocationSpecifier locationSpecifier) Removes the given location specifier.
void	setAccessDriverType(java.lang.String accessDriverType) Set the access driver type.
void	setAccessParameters(java.lang.String accessParameters) Set the access driver's parameters.
void	setAccessParametersFragment(SQLFragment frag) Sets the driver's access parameters derived as a SQLFragment.
void	setAccessUsingClob(boolean accessUsingClob) Sets whether the access parameters are defined using a clob subquery.
void	setDefaultDirectory(DBObjectID defaultDirectory) Sets the default Directory by ID.
void	setLocationSpecifiers(OracleExternalTableProperties.LocationSpecifier[] locationSpecifiers) Sets the LocationSpecifiers which are used to specify the external locations used to store the table's data.
void	setProjectColumn(OracleExternalTableProperties.ProjectColumn projectColumn) Set the value of the 'alter table project column clause'.
void	setRejectLimit(java.lang.Integer rejectLimit) Sets the reject limit for the external table.

Methods inherited from class oracle.javatools.db.AbstractChildBuildableObject

setParent

Methods inherited from class oracle.javatools.db.AbstractBuildableObject

checkInit, checkInit, copyToImpl, getOwnedObjectsImpl, getProperties, getReferenceIDsImpl, needsInitialization, processPropertyChange, setID

Methods inherited from class oracle.javatools.db.AbstractDBObject

addObjectListener, addObjectListener, addObjectListener, changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyTo, equals, equalsImpl, findOwnedObject, findOwnedObject, findOwnedObject, findOwnedObject, findParent, fireObjectUpdated, firePropertyChanged, getChildSupport, getChildSupport, getID, getName, getOwnedObjects, getOwnedObjects, getParent, getProperty, getProperty, getReferenceIDs, hashCode, includeOwnedObject, includesType, includesType, removeObjectListener, removeObjectListener, removeObjectListener, removeOwnedObject, removeThisAsParent, replaceReferenceIDs, 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, getName, getOwnedObjects, getOwnedObjects, getProperties, getProperty, getProperty, getReferenceIDs, hashCode, removeObjectListener, removeOwnedObject, replaceReferenceIDs, setID, setName, setProperties, setProperty

Field Detail

KEY

public static final java.lang.String KEY

KEY for use in getProperty/setProperty on a Table object to query the external table properties.

See Also:

Constant Field Values

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

ACCESS_DRIVER_TYPE_ORACLE_LOADER

public static final java.lang.String ACCESS_DRIVER_TYPE_ORACLE_LOADER

Access driver type ORACLE_LOADER.

See Also:

Constant Field Values

ACCESS_DRIVER_TYPE_ORACLE_DATAPUMP

public static final java.lang.String ACCESS_DRIVER_TYPE_ORACLE_DATAPUMP

Access driver type ORACLE_DATAPUMP.

See Also:

Constant Field Values

ACCESS_DRIVER_TYPE_ORACLE_HIVE

public static final java.lang.String ACCESS_DRIVER_TYPE_ORACLE_HIVE

Access driver type ORACLE_HIVE. Available in the database from 12.1.0.2.

See Also:

BigDataAccessParameters, Constant Field Values

ACCESS_DRIVER_TYPE_ORACLE_HDFS

public static final java.lang.String ACCESS_DRIVER_TYPE_ORACLE_HDFS

Access driver type ORACLE_HDFS. Available in the database from 12.1.0.2.

See Also:

BigDataAccessParameters, Constant Field Values

ACCESS_DRIVER_TYPE_ORACLE_BIGDATA

public static final java.lang.String ACCESS_DRIVER_TYPE_ORACLE_BIGDATA

Access driver type ORACLE_BIGDATA. Available in the database from 12.1.0.2.

See Also:

BigDataAccessParameters, Constant Field Values

REJECT_LIMIT_UNLIMITED

public static final int REJECT_LIMIT_UNLIMITED

Value for the rejectLimit property that represents "UNLIMITED".

See Also:

Constant Field Values

Constructor Detail

OracleExternalTableProperties

public OracleExternalTableProperties()

Creates an empty OracleExternalTableProperties object, which is used to define the properties of an external table.

Method Detail

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.

setDefaultDirectory

public void setDefaultDirectory(DBObjectID defaultDirectory)

Sets the default Directory by ID. The default directory is used for any LocationSpecifiers that have a null directory.

getDefaultDirectory

public DBObjectID getDefaultDirectory()

Gets the default Directory by ID. The default directory is used for any LocationSpecifiers that have a null directory.

setLocationSpecifiers

public void setLocationSpecifiers(OracleExternalTableProperties.LocationSpecifier[] locationSpecifiers)

Sets the LocationSpecifiers which are used to specify the external locations used to store the table's data.

See Also:

OracleExternalTableProperties.LocationSpecifier

getLocationSpecifiers

public OracleExternalTableProperties.LocationSpecifier[] getLocationSpecifiers()

Gets the LocationSpecifiers which are used to specify the external locations used to store the table's data.

See Also:

OracleExternalTableProperties.LocationSpecifier

addLocationSpecifier

public void addLocationSpecifier(OracleExternalTableProperties.LocationSpecifier locationSpecifier)

Adds the given location specifier.

See Also:

setLocationSpecifiers(oracle.javatools.db.ora.OracleExternalTableProperties.LocationSpecifier[]), OracleExternalTableProperties.LocationSpecifier

addLocationSpecifier

public void addLocationSpecifier(DBObjectID directory,
                                 java.lang.String specifier)

Adds a location specifier that uses the given Directory (by ID) and the specified location.

See Also:

setLocationSpecifiers(oracle.javatools.db.ora.OracleExternalTableProperties.LocationSpecifier[]), OracleExternalTableProperties.LocationSpecifier

addLocationSpecifier

public void addLocationSpecifier(java.lang.String specifier)

Adds a location specifier that uses the given Directory (by ID) and the specified location.

See Also:

setLocationSpecifiers(oracle.javatools.db.ora.OracleExternalTableProperties.LocationSpecifier[]), OracleExternalTableProperties.LocationSpecifier

removeLocationSpecifier

public void removeLocationSpecifier(OracleExternalTableProperties.LocationSpecifier locationSpecifier)

Removes the given location specifier.

See Also:

setLocationSpecifiers(oracle.javatools.db.ora.OracleExternalTableProperties.LocationSpecifier[]), OracleExternalTableProperties.LocationSpecifier

removeAllLocationSpecifiers

public void removeAllLocationSpecifiers()

Clears the list of LocationSpecifiers.

See Also:

setLocationSpecifiers(oracle.javatools.db.ora.OracleExternalTableProperties.LocationSpecifier[]), OracleExternalTableProperties.LocationSpecifier

setAccessDriverType

public void setAccessDriverType(java.lang.String accessDriverType)

Set the access driver type. There are constants defined on this class ACCESS_DRIVER_TYPE_* for the known Oracle access drivers.

getAccessDriverType

public java.lang.String getAccessDriverType()

Get the access driver type. There are constants defined on this class ACCESS_DRIVER_TYPE_* for the known Oracle access drivers.

setAccessParameters

public void setAccessParameters(java.lang.String accessParameters)

Set the access driver's parameters. This may be an SQLQuery or String representing a USING CLOB subquery, or an OpaqueFormatSpec or String representing an opaque format spec.

getAccessParameters

public java.lang.String getAccessParameters()

Get the access driver's parameters.

See Also:

setAccessParameters(java.lang.String)

setAccessParametersFragment

public void setAccessParametersFragment(SQLFragment frag)

Sets the driver's access parameters derived as a SQLFragment.

Parameters:

frag - the access parameters fragment

getAccessParametersFragment

public SQLFragment getAccessParametersFragment()

Gets the driver's access parameters derived as a SQLFragment.

Returns:

the access parameters fragment

setAccessUsingClob

public void setAccessUsingClob(boolean accessUsingClob)

Sets whether the access parameters are defined using a clob subquery. If the are the access parameters value should be a subquery.

Parameters:

accessUsingClob - whether the access parameters are defined using a clob subquery

isAccessUsingClob

public boolean isAccessUsingClob()

Gets whether the access parameters are defined using a clob subquery.

Returns:

true if access is using clob (and therefore the access parameters should be a subquery).

setRejectLimit

public void setRejectLimit(java.lang.Integer rejectLimit)

Sets the reject limit for the external table. This is the number of conversion errors that can occur during a query of the external data before the database errors. To specify a value of UNLIMITED use REJECT_LIMIT_UNLIMITED.

Parameters:

the - reject limit

getRejectLimit

public java.lang.Integer getRejectLimit()

Gets the reject limit for the external table. This is the number of conversion errors that can occur during a query of the external data before the database errors. If the limit is UNLIMITED the value will be REJECT_LIMIT_UNLIMITED.

Returns:

the reject limit.

setProjectColumn

public void setProjectColumn(OracleExternalTableProperties.ProjectColumn projectColumn)

Set the value of the 'alter table project column clause'.

See Also:

OracleExternalTableProperties.ProjectColumn

getProjectColumn

public OracleExternalTableProperties.ProjectColumn getProjectColumn()

Get the value of the 'alter table project column clause'.

See Also:

OracleExternalTableProperties.ProjectColumn