com.sas.cas.actions

Class Dsodbc

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.Dsodbc

All Implemented Interfaces:

KeyedMap<java.lang.String,java.lang.Object>, java.io.Serializable, java.util.Map<java.lang.String,java.lang.Object>

public class Dsodbc
extends CASGeneratedActionOptions

Options for dsodbc.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Dsodbc.SRCTYPE

Nested classes/interfaces inherited from class com.sas.cas.CASActionOptions

CASActionOptions.EnumValue, CASActionOptions.FORMAT

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_AUTHENTICATIONDOMAIN
static java.lang.String	KEY_CATALOG
static java.lang.String	KEY_CHARMULTIPLIER
static java.lang.String	KEY_CLIENT_ENCODING
static java.lang.String	KEY_CONOPTS
static java.lang.String	KEY_DM_UNICODE
static java.lang.String	KEY_ODBC_DSN
static java.lang.String	KEY_PWD
static java.lang.String	KEY_READBUFF
static java.lang.String	KEY_SCHEMA
static java.lang.String	KEY_SRCTYPE
static java.lang.String	KEY_UID

Fields inherited from class com.sas.cas.CASActionOptions

FLAGS_EXPAND_ARRAYS, FLAGS_IGNORE_DISPOSITION_ERROR, FLAGS_RETURN_RESULTS_ON_EXCEPTION, FLAGS_SKIP_ACTION_EVENTS, FLAGS_SKIP_RESULTS, HIDDEN_PASSWORD, JSON_NULL, LUA_NIL, PARAMETER_FLAG_ISPASSWORD, PARAMETER_FLAG_ISPATH, PARAMETER_FLAG_ISTABLENAME, PARAMETER_FLAG_ISVAR, PARAMETER_FLAG_REQUIRED, PYTHON_NULL, SERIALIZED_PREFIX

Constructor Summary

Constructors

Constructor and Description
Dsodbc()
Dsodbc(CASActionOptions options)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAuthDomain()
java.lang.String	getAuthenticationDomain()
java.lang.String	getCatalog()
java.lang.Double	getCharMultiplier()
java.lang.String	getClient_encoding()
java.lang.String	getConopts()
java.lang.String	getDatabase()
java.lang.String	getDb()
java.lang.String	getDm_unicode()
java.lang.String	getOdbc_dsn()
java.lang.String	getPass()
java.lang.String	getPassword()
java.lang.String	getPwd()
java.lang.Integer	getRas()
java.lang.Integer	getReadbuff()
java.lang.Integer	getRow_array_size()
java.lang.String	getSchema()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
Dsodbc.SRCTYPE	getSrcType()
java.lang.String	getUid()
java.lang.String	getUser()
java.lang.String	getUsername()
Dsodbc	setAuthDomain(java.lang.String value)
Dsodbc	setAuthenticationDomain(java.lang.String value) Sets the value of parameter 'authenticationDomain': specifies the authentication domain that is used to retrieve database credentials.
Dsodbc	setCatalog(java.lang.String value) Sets the value of parameter 'catalog': specifies the database catalog name.
Dsodbc	setCharMultiplier(java.lang.Double value) Sets the value of parameter 'charMultiplier': specifies a multiplier value to expand fixed-width character variables that might require transcoding.
Dsodbc	setClient_encoding(java.lang.String value) Sets the value of parameter 'client_encoding': specifies the client encoding type to use when connecting to the data source.
Dsodbc	setConopts(java.lang.String value) Sets the value of parameter 'conopts': specifies connection options to use for connecting to the Teradata database.
Dsodbc	setDatabase(java.lang.String value)
Dsodbc	setDb(java.lang.String value)
Dsodbc	setDm_unicode(java.lang.String value) Sets the value of parameter 'dm_unicode': specifies to override the default driver manager Unicode setting.
Dsodbc	setOdbc_dsn(java.lang.String value) Sets the value of parameter 'odbc_dsn': specifies a data source name that is already configured.
Dsodbc	setPass(java.lang.String value)
Dsodbc	setPassword(java.lang.String value)
Dsodbc	setPwd(java.lang.String value) Sets the value of parameter 'pwd'.
Dsodbc	setRas(java.lang.Integer value)
Dsodbc	setReadbuff(java.lang.Integer value) Sets the value of parameter 'readbuff': specifies the row array size to use for reading tables.
Dsodbc	setRow_array_size(java.lang.Integer value)
Dsodbc	setSchema(java.lang.String value) Sets the value of parameter 'schema': specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
Dsodbc	setSrcType(Dsodbc.SRCTYPE value) Sets the value of parameter 'srcType'.
Dsodbc	setUid(java.lang.String value) Sets the value of parameter 'uid'.
Dsodbc	setUser(java.lang.String value)
Dsodbc	setUsername(java.lang.String value)

Methods inherited from class com.sas.cas.CASActionOptions

addActionFlags, addParameterFlag, appendValue, checkForPasswords, clear, containsKey, containsValue, convertToEnumArray, copy, deserialize, entrySet, equals, findOptionsClass, findSetter, get, getActionFlags, getActionName, getActionResponseEventListener, getActionResultEventListener, getActionSetName, getCASClient, getClassName, getDebugOptions, getDispositionEventListener, getFullyQualifiedActionName, getLogEventListener, getLogMessage, getMessageOutputStream, getMessageTagHandler, getParameter, getParameterAsBoolean, getParameterAsByteArray, getParameterAsDouble, getParameterAsDoubleArray, getParameterAsInteger, getParameterAsIntegerArray, getParameterAsLong, getParameterAsLongArray, getParameterAsString, getParameterAsStringArray, getParameterFlags, getParameterIgnoreCase, getParameterIgnoreCase, getParameterKeys, getPerformanceEventListener, getPropertyKey, getSessionID, getUserProperty, getUserPropertyKeys, hashCode, invoke, isEmpty, isFlagSet, isMap, isParameterFlagSet, isPassword, isPath, isRequired, isTable, isVariable, keySet, put, putAll, putAllDeep, putDeep, putDeep, quoteIfNotNull, remove, removeParameter, set, setActionFlags, setActionName, setActionResponseEventListener, setActionResultEventListener, setActionSetName, setCASClient, setDebugOptions, setDispositionEventListener, setFullyQualifiedActionName, setLogEventListener, setLogMessage, setMessageOutputStream, setMessageTagHandler, setParameter, setPerformanceEventListener, setPropertyKey, setSessionID, setUserProperty, size, toCASLString, toLuaString, toLuaString, toOptionsWithGeneratedClasses, toSerialized, toString, toString, toString, upcaseFirstChar, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

KEY_UID

public static final java.lang.String KEY_UID

See Also:

Constant Field Values

KEY_PWD

public static final java.lang.String KEY_PWD

See Also:

Constant Field Values

KEY_AUTHENTICATIONDOMAIN

public static final java.lang.String KEY_AUTHENTICATIONDOMAIN

See Also:

Constant Field Values

KEY_CATALOG

public static final java.lang.String KEY_CATALOG

See Also:

Constant Field Values

KEY_CONOPTS

public static final java.lang.String KEY_CONOPTS

See Also:

Constant Field Values

KEY_READBUFF

public static final java.lang.String KEY_READBUFF

See Also:

Constant Field Values

KEY_CHARMULTIPLIER

public static final java.lang.String KEY_CHARMULTIPLIER

See Also:

Constant Field Values

KEY_SRCTYPE

public static final java.lang.String KEY_SRCTYPE

See Also:

Constant Field Values

KEY_ODBC_DSN

public static final java.lang.String KEY_ODBC_DSN

See Also:

Constant Field Values

KEY_CLIENT_ENCODING

public static final java.lang.String KEY_CLIENT_ENCODING

See Also:

Constant Field Values

KEY_DM_UNICODE

public static final java.lang.String KEY_DM_UNICODE

See Also:

Constant Field Values

KEY_SCHEMA

public static final java.lang.String KEY_SCHEMA

See Also:

Constant Field Values

Constructor Detail

Dsodbc

public Dsodbc()

Dsodbc

public Dsodbc(CASActionOptions options)

Method Detail

getServerDefaultValue

public java.lang.Object getServerDefaultValue(java.lang.String key)

Description copied from class: CASActionOptions

Gets the server default value, if known.

Overrides:

getServerDefaultValue in class CASActionOptions

Parameters:

key - The parameter key

Returns:

THe default value, or null if not known

getUid

public java.lang.String getUid()

getUser

public java.lang.String getUser()

getUsername

public java.lang.String getUsername()

setUid

public Dsodbc setUid(java.lang.String value)

Sets the value of parameter 'uid'.

Parameters:

value - The value

Returns:

The options object

setUser

public Dsodbc setUser(java.lang.String value)

setUsername

public Dsodbc setUsername(java.lang.String value)

getPwd

public java.lang.String getPwd()

getPassword

public java.lang.String getPassword()

getPass

public java.lang.String getPass()

setPwd

public Dsodbc setPwd(java.lang.String value)

Sets the value of parameter 'pwd'.

Parameters:

value - The value

Returns:

The options object

setPassword

public Dsodbc setPassword(java.lang.String value)

setPass

public Dsodbc setPass(java.lang.String value)

getAuthenticationDomain

public java.lang.String getAuthenticationDomain()

getAuthDomain

public java.lang.String getAuthDomain()

setAuthenticationDomain

public Dsodbc setAuthenticationDomain(java.lang.String value)

Sets the value of parameter 'authenticationDomain': specifies the authentication domain that is used to retrieve database credentials.

Parameters:

value - The value

Returns:

The options object

setAuthDomain

public Dsodbc setAuthDomain(java.lang.String value)

getCatalog

public java.lang.String getCatalog()

setCatalog

public Dsodbc setCatalog(java.lang.String value)

Sets the value of parameter 'catalog': specifies the database catalog name.

Parameters:

value - The value

Returns:

The options object

getConopts

public java.lang.String getConopts()

setConopts

public Dsodbc setConopts(java.lang.String value)

Sets the value of parameter 'conopts': specifies connection options to use for connecting to the Teradata database.

Parameters:

value - The value

Returns:

The options object

getReadbuff

public java.lang.Integer getReadbuff()

getRas

public java.lang.Integer getRas()

getRow_array_size

public java.lang.Integer getRow_array_size()

setReadbuff

public Dsodbc setReadbuff(java.lang.Integer value)

Sets the value of parameter 'readbuff': specifies the row array size to use for reading tables. The value is measured in bytes.

Parameters:

value - The value

Returns:

The options object

setRas

public Dsodbc setRas(java.lang.Integer value)

setRow_array_size

public Dsodbc setRow_array_size(java.lang.Integer value)

getCharMultiplier

public java.lang.Double getCharMultiplier()

setCharMultiplier

public Dsodbc setCharMultiplier(java.lang.Double value)

Sets the value of parameter 'charMultiplier': specifies a multiplier value to expand fixed-width character variables that might require transcoding. SAS expands the lengths to avoid character data truncation. The lengths are increased by multiplying the length by the specified value. The server default is 1.

Parameters:

value - The value

Returns:

The options object

getSrcType

public Dsodbc.SRCTYPE getSrcType()

setSrcType

public Dsodbc setSrcType(Dsodbc.SRCTYPE value)

Sets the value of parameter 'srcType'. The server default is SRCTYPE.ODBC.

Parameters:

value - The value

Returns:

The options object

getOdbc_dsn

public java.lang.String getOdbc_dsn()

getDb

public java.lang.String getDb()

getDatabase

public java.lang.String getDatabase()

setOdbc_dsn

public Dsodbc setOdbc_dsn(java.lang.String value)

Sets the value of parameter 'odbc_dsn': specifies a data source name that is already configured. Using this method to connect requires additional setup such as the Administrator control panel on Windows or through the odbc.ini file on UNIX platforms.

Parameters:

value - The value

Returns:

The options object

setDb

public Dsodbc setDb(java.lang.String value)

setDatabase

public Dsodbc setDatabase(java.lang.String value)

getClient_encoding

public java.lang.String getClient_encoding()

setClient_encoding

public Dsodbc setClient_encoding(java.lang.String value)

Sets the value of parameter 'client_encoding': specifies the client encoding type to use when connecting to the data source.

Parameters:

value - The value

Returns:

The options object

getDm_unicode

public java.lang.String getDm_unicode()

setDm_unicode

public Dsodbc setDm_unicode(java.lang.String value)

Sets the value of parameter 'dm_unicode': specifies to override the default driver manager Unicode setting. DataDirect defaults to UTF-8 on UNIX. UnixODBC based drivers use UCS-2. Specify UCS2 for unixODBC based drivers.

Parameters:

value - The value

Returns:

The options object

getSchema

public java.lang.String getSchema()

setSchema

public Dsodbc setSchema(java.lang.String value)

Sets the value of parameter 'schema': specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

Parameters:

value - The value

Returns:

The options object