Partilhar via

Classe DataCommand

  • Artigo

Fornece a capacidade de criar e executar comandos de dados de vários tipos de fontes de dados, e recuperar resultados somente leitura ou um código de status de comando.

Hierarquia de herança

Object
  Microsoft.VisualStudio.Data.Framework.DataSiteableObject<IVsDataConnection>
    Microsoft.VisualStudio.Data.Framework.DataCommand

Namespace:  Microsoft.VisualStudio.Data.Framework
Assembly:  Microsoft.VisualStudio.Data.Framework (em Microsoft.VisualStudio.Data.Framework.dll)

Sintaxe

'Declaração
Public MustInherit Class DataCommand _
    Inherits DataSiteableObject(Of IVsDataConnection) _
    Implements IVsDataCommand

public abstract class DataCommand : DataSiteableObject<IVsDataConnection>, 
    IVsDataCommand

public ref class DataCommand abstract : public DataSiteableObject<IVsDataConnection^>, 
    IVsDataCommand

[<AbstractClass>]
type DataCommand =  
    class 
        inherit DataSiteableObject<IVsDataConnection>
        interface IVsDataCommand 
    end

public abstract class DataCommand extends DataSiteableObject<IVsDataConnection> implements IVsDataCommand

O tipo DataCommand expõe os membros a seguir.

Construtores

  Nome Descrição
Método protegido DataCommand() Inicializa uma nova instância da classe DataCommand.
Método protegido DataCommand(IVsDataConnection) Inicializa uma nova instância da classe DataCommand juntamente com um objeto de conexão de dados.

Superior

Propriedades

  Nome Descrição
Propriedade pública Site Obtém ou define o site do objeto. (Herdado de DataSiteableObject<T>.)

Superior

Métodos

  Nome Descrição
Método público CreateParameter Cria um objeto de parâmetro que pode ser passado em DeriveSchema, em DeriveSchema, em Execute, ou os métodos do ExecuteWithoutResults em uma instância de DataCommand .
Método público DeriveParameters(String) Deriva os parâmetros que podem ser especificados para um determinado comando.
Método público DeriveParameters(String, DataCommandType) Deriva os parâmetros que podem ser especificados para um determinado comando.
Método público DeriveParameters(String, DataCommandType, Int32) Deriva os parâmetros que podem ser especificados para um determinado comando.
Método público DeriveSchema(String) O esquema é retornado de um comando especificado.O esquema indica o layout de itens e os blocos em um leitor de dados.
Método público DeriveSchema(String, DataCommandType) O esquema é retornado de um comando especificado.O esquema indica o layout de itens e os blocos em um leitor de dados.
Método público DeriveSchema(String, DataCommandType, array<IVsDataParameter[]) O esquema é retornado de um comando especificado.O esquema indica o layout de itens e os blocos em um leitor de dados.
Método público DeriveSchema(String, DataCommandType, array<IVsDataParameter[], Int32) O esquema é retornado de um comando especificado.O esquema indica o layout de itens e os blocos em um leitor de dados.
Método público Equals Determines whether the specified object is equal to the current object. (Herdado de Object.)
Método público Execute(String) Executa um comando especificado e retorna resultados somente leitura.
Método público Execute(String, DataCommandType) Executa um comando especificado e retorna resultados somente leitura.
Método público Execute(String, DataCommandType, array<IVsDataParameter[]) Executa um comando especificado, opcionalmente com parâmetros, e somente leitura resulta de retorna.
Método público Execute(String, DataCommandType, array<IVsDataParameter[], Int32) Executa um comando especificado, opcionalmente com parâmetros, e somente leitura resulta de retorna.
Método público ExecuteWithoutResults(String) Executa um comando mas não requer resultados, em vez de retornando um inteiro que indica o resultado de chamada.
Método público ExecuteWithoutResults(String, DataCommandType) Executa um comando mas não requer resultados, em vez de retornando um inteiro que indica o resultado de chamada.
Método público ExecuteWithoutResults(String, DataCommandType, array<IVsDataParameter[]) Executa um comando, opcionalmente com parâmetros, mas não requer resultados, em vez de retornando um inteiro que indica o resultado de chamada.
Método público ExecuteWithoutResults(String, DataCommandType, array<IVsDataParameter[], Int32) Executa um comando, opcionalmente com parâmetros, mas não requer resultados, em vez de retornando um inteiro que indica o resultado de chamada.
Método protegido Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Herdado de Object.)
Método público GetHashCode Serves as the default hash function. (Herdado de Object.)
Método público GetType Gets the Type of the current instance. (Herdado de Object.)
Método protegido MemberwiseClone Creates a shallow copy of the current Object. (Herdado de Object.)
Método protegido OnSiteChanged Gera o evento SiteChanged. (Herdado de DataSiteableObject<T>.)
Método público Prepare(String) Prepara o comando especificado na fonte de dados ser executado; o comando pode então ser executado várias vezes, com parâmetros de variação.
Método público Prepare(String, DataCommandType) Prepara o comando especificado na fonte de dados ser executado; o comando pode então ser executado várias vezes, com parâmetros de variação.
Método público Prepare(String, DataCommandType, array<IVsDataParameter[]) Prepara o comando especificado na fonte de dados ser executado; o comando pode então ser executado várias vezes, com parâmetros de variação.
Método público Prepare(String, DataCommandType, array<IVsDataParameter[], Int32) Prepara o comando especificado na fonte de dados ser executado; o comando pode então ser executado várias vezes, com parâmetros de variação.
Método público ToString Returns a string that represents the current object. (Herdado de Object.)

Superior

Eventos

  Nome Descrição
Evento público SiteChanged Ocorre quando a propriedade de Site é alterada. (Herdado de DataSiteableObject<T>.)

Superior

Comentários

Provedores de (DDEX) de extensibilidade designer de dados podem executar vários tipos de comandos contra uma fonte de dados. Isso não pode incluir, mas a ser associado, instruções SQL, procedimentos, e chamadas de função. Também podem expor a capacidade de preparar e derivar parâmetros e esquemas para comandos.

A classe de DataCommand apresenta tipos de comando. Um tipo de comando indica uma interpretação através de uma cadeia de caracteres de comando fornecida. Por exemplo, um texto do tipo de comando pode notificar o provedor de DDEX que a cadeia de caracteres de comando é uma instrução SQL que deve ser executada diretamente. Como alternativa, um tipo de comando de TabularFunction pode notificar o provedor de DDEX que a cadeia de caracteres de comando é o nome de uma função de tabela valorizada que deve ser executada usando o método apropriado.

Tecnologias subjacentes como o ODBC (ODBC), o OLE DB, e a tentativa de ADO.NET enumerar um conjunto de tipos permitidos de comando, normalmente como texto sem formatação, no formulário da tabela, ou como procedimentos armazenados. A classe de DataCommand estende esse conceito relaxando o requisito que esse tipo de comando se origina em uma enumeração fixa. Isso fornece flexibilidade ativando provedores de DDEX para adicionar tipos personalizados de comando, juntamente com descrições de como e quando os comandos podem ser usados.

Dica

Para fornecer de forma assíncrona o recurso de execução do comando, use a classe de DataAsyncCommand .Esta classe tem um conjunto de métodos que são equivalentes aquelas na classe de DataCommand , mas esses métodos operam de forma assíncrona.

Observações para herdeiros

Quando você herda da classe de DataCommand , você deve substituir cada método dessa classe que deve ser suportada por sua implementação de provedor de DDEX. A implementação base de cada método nessa classe gerencie NotSupportedException.

Observe que o método de ExecuteWithoutResults tem uma implementação base que representantes para o método de Execute .

Acesso thread-safe

Quaisquer membros estático (Shared no Visual Basic) públicos deste tipo são thread-safe. Não há garantia de que qualquer membro de instância seja thread-safe.

Consulte também

Referência

Namespace Microsoft.VisualStudio.Data.Framework

DataCommandType