AdomdCommand Class

Represents a command to run against an analytical data source.

Inheritance Hierarchy

Object
  Microsoft.AnalysisServices.AdomdServer.AdomdCommand

Namespace:  Microsoft.AnalysisServices.AdomdServer
Assembly:  msmgdsrv (in msmgdsrv.dll)

Syntax

'Declaration
Public NotInheritable Class AdomdCommand _
    Implements IDisposable, IDbCommand, ICloneable
'Usage
Dim instance As AdomdCommand
public sealed class AdomdCommand : IDisposable, 
    IDbCommand, ICloneable
public ref class AdomdCommand sealed : IDisposable, 
    IDbCommand, ICloneable
[<SealedAttribute>]
type AdomdCommand =  
    class 
        interface IDisposable 
        interface IDbCommand 
        interface ICloneable 
    end
public final class AdomdCommand implements IDisposable, IDbCommand, ICloneable

The AdomdCommand type exposes the following members.

Constructors

  Name Description
Public method AdomdCommand() Initializes a new instance of the AdomdCommand class with default values.
Public method AdomdCommand(String) Initializes a new instance of the AdomdCommand class with the text of the command.

Top

Properties

  Name Description
Public property CommandText Gets or sets the command to run.
Public property CommandTimeout Gets or sets the time to wait for a command to run before the AdomdCommand stops trying to run the command and generates an error.
Public property CommandType Gets or sets the CommandType used by the AdomdCommand.
Public property Parameters Gets an instance of an AdomdParameterCollection class that contains the parameters that the AdomdCommand uses to run the command.

Top

Methods

  Name Description
Public method {dtor} Releases all resources used by the AdomdCommand.
Public method Cancel Tries to cancel the command that the AdomdCommand is currently running.
Public method Clone Creates and returns an instance of an AdomdCommand class based on the current AdomdCommand.
Public method CreateParameter Returns a newly created AdomdParameter.
Public method Dispose Releases all resources used by the AdomdCommand.
Public method Equals (Inherited from Object.)
Public method ExecuteNonQuery Runs the AdomdCommand without returning any results.
Public method ExecuteReader() Runs the AdomdCommand and returns an AdomdDataReader.
Public method ExecuteReader(CommandBehavior) Runs the AdomdCommand using the specified CommandBehavior enumeration value and returns an AdomdDataReader.
Public method ExecuteScalar Executes the statement and returns the first object of the first column.
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method Prepare Verifies that the AdomdCommand can run.
Public method ToString (Inherited from Object.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method ICloneableClone Creates a new object that is a copy of the current instance of this object.
Explicit interface implemetationPrivate method IDbCommandCreateParameter Creates and returns a new instance of an IDbDataParameter object.
Explicit interface implemetationPrivate method IDbCommandExecuteReader() Executes the CommandText against the Connection and builds an IDataReader.
Explicit interface implemetationPrivate method IDbCommandExecuteReader(CommandBehavior) Executes the CommandText against the Connection and builds an IDataReader using one of the CommandBehavior values.

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.AnalysisServices.AdomdServer Namespace