com.aspose.cells

Class DBConnection

java.lang.Object

com.aspose.cells.ExternalConnection

com.aspose.cells.DBConnection

public class DBConnection
extends ExternalConnection

Specifies all properties associated with an ODBC or OLE DB external data connection.

Method Summary

Methods

Modifier and Type	Method and Description
int	getClassType() Gets the type of this ExternalConnection object.
java.lang.String	getCommand() The string containing the database command to pass to the data provider API that will interact with the external source in order to retrieve data
int	getCommandType() Specifies the OLE DB command type.
java.lang.String	getConnectionInfo() Deprecated. Use ExternalConnection.ConnectionString property instead.
java.lang.String	getConnectionString() The connection information string is used to make contact with an OLE DB or ODBC data source.
PowerQueryFormula	getPowerQueryFormula() Gets the definition of power query formula.
java.lang.String	getSecondCommand() Specifies a second command text string that is persisted when PivotTable server-based page fields are in use.
java.lang.String	getSeverCommand() Deprecated. Use ExternalConnection.SecondCommand property instead.
void	setCommand(java.lang.String value) The string containing the database command to pass to the data provider API that will interact with the external source in order to retrieve data
void	setCommandType(int value) Specifies the OLE DB command type.
void	setConnectionInfo(java.lang.String value) Deprecated. Use ExternalConnection.ConnectionString property instead.
void	setConnectionString(java.lang.String value) The connection information string is used to make contact with an OLE DB or ODBC data source.
void	setSecondCommand(java.lang.String value) Specifies a second command text string that is persisted when PivotTable server-based page fields are in use.
void	setSeverCommand(java.lang.String value) Deprecated. Use ExternalConnection.SecondCommand property instead.

Methods inherited from class com.aspose.cells.ExternalConnection

getBackgroundRefresh, getConnectionDescription, getConnectionFile, getConnectionId, getCredentials, getCredentialsMethodType, getId, getKeepAlive, getName, getOdcFile, getOnlyUseConnectionFile, getParameters, getReconnectionMethod, getReconnectionMethodType, getRefreshInternal, getRefreshOnLoad, getSaveData, getSavePassword, getSourceFile, getSourceType, getSSOId, getType, isDeleted, isNew, setBackgroundRefresh, setConnectionDescription, setCredentials, setCredentialsMethodType, setDeleted, setKeepAlive, setName, setNew, setOdcFile, setOnlyUseConnectionFile, setReconnectionMethod, setReconnectionMethodType, setRefreshInternal, setRefreshOnLoad, setSaveData, setSavePassword, setSourceFile, setSourceType, setSSOId, setType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getClassType

public int getClassType()

Gets the type of this ExternalConnection object.

See ExternalConnectionClassType.

Specified by:

getClassType in class ExternalConnection

getConnectionString

public java.lang.String getConnectionString()

The connection information string is used to make contact with an OLE DB or ODBC data source.

Overrides:

getConnectionString in class ExternalConnection

setConnectionString

public void setConnectionString(java.lang.String value)

The connection information string is used to make contact with an OLE DB or ODBC data source.

Overrides:

setConnectionString in class ExternalConnection

getConnectionInfo

public java.lang.String getConnectionInfo()

Deprecated. Use ExternalConnection.ConnectionString property instead.

The connection information string is used to make contact with an OLE DB or ODBC data source.

Remarks

NOTE: This property is now obsolete. Instead, please use ExternalConnection.ConnectionString property. This method will be removed 12 months later since October 2024. Aspose apologizes for any inconvenience you may have experienced.

setConnectionInfo

public void setConnectionInfo(java.lang.String value)

Deprecated. Use ExternalConnection.ConnectionString property instead.

The connection information string is used to make contact with an OLE DB or ODBC data source.

Remarks

NOTE: This property is now obsolete. Instead, please use ExternalConnection.ConnectionString property. This method will be removed 12 months later since October 2024. Aspose apologizes for any inconvenience you may have experienced.

getPowerQueryFormula

public PowerQueryFormula getPowerQueryFormula()

Gets the definition of power query formula.

Overrides:

getPowerQueryFormula in class ExternalConnection

getCommandType

public int getCommandType()

Specifies the OLE DB command type. 1. Query specifies a cube name 2. Query specifies a SQL statement 3. Query specifies a table name 4. Query specifies that default information has been given, and it is up to the provider how to interpret. 5. Query is against a web based List Data Provider.

See OLEDBCommandType.

Overrides:

getCommandType in class ExternalConnection

setCommandType

public void setCommandType(int value)

Specifies the OLE DB command type. 1. Query specifies a cube name 2. Query specifies a SQL statement 3. Query specifies a table name 4. Query specifies that default information has been given, and it is up to the provider how to interpret. 5. Query is against a web based List Data Provider.

See OLEDBCommandType.

Overrides:

setCommandType in class ExternalConnection

getCommand

public java.lang.String getCommand()

The string containing the database command to pass to the data provider API that will interact with the external source in order to retrieve data

Overrides:

getCommand in class ExternalConnection

setCommand

public void setCommand(java.lang.String value)

The string containing the database command to pass to the data provider API that will interact with the external source in order to retrieve data

Overrides:

setCommand in class ExternalConnection

getSeverCommand

public java.lang.String getSeverCommand()

Deprecated. Use ExternalConnection.SecondCommand property instead.

Specifies a second command text string that is persisted when PivotTable server-based page fields are in use. For ODBC connections, serverCommand is usually a broader query than command (no WHERE clause is present in the former). Based on these 2 commands(Command and ServerCommand), parameter UI can be populated and parameterized queries can be constructed

Remarks

NOTE: This property is now obsolete. Instead, please use ExternalConnection.SecondCommand property. This method will be removed 12 months later since October 2024. Aspose apologizes for any inconvenience you may have experienced.

setSeverCommand

public void setSeverCommand(java.lang.String value)

Deprecated. Use ExternalConnection.SecondCommand property instead.

Specifies a second command text string that is persisted when PivotTable server-based page fields are in use. For ODBC connections, serverCommand is usually a broader query than command (no WHERE clause is present in the former). Based on these 2 commands(Command and ServerCommand), parameter UI can be populated and parameterized queries can be constructed

Remarks

NOTE: This property is now obsolete. Instead, please use ExternalConnection.SecondCommand property. This method will be removed 12 months later since October 2024. Aspose apologizes for any inconvenience you may have experienced.

getSecondCommand

public java.lang.String getSecondCommand()

Specifies a second command text string that is persisted when PivotTable server-based page fields are in use. For ODBC connections, serverCommand is usually a broader query than command (no WHERE clause is present in the former). Based on these 2 commands(Command and ServerCommand), parameter UI can be populated and parameterized queries can be constructed

Overrides:

getSecondCommand in class ExternalConnection

setSecondCommand

public void setSecondCommand(java.lang.String value)

Specifies a second command text string that is persisted when PivotTable server-based page fields are in use. For ODBC connections, serverCommand is usually a broader query than command (no WHERE clause is present in the former). Based on these 2 commands(Command and ServerCommand), parameter UI can be populated and parameterized queries can be constructed

Overrides:

setSecondCommand in class ExternalConnection