SugarCommand Class

In This Topic

Syntax
Remarks
Example
Inheritance Hierarchy
Requirements
See Also

Represents a SQL statement or stored procedure to execute against SugarCRM.

Syntax

Visual Basic
C#

public class SugarCommand : Devart.Data.SqlShimCommand, System.ComponentModel.IComponent, System.Data.IDbCommand, System.ICloneable, System.IDisposable

'Declaration
 
Public Class SugarCommand 
   Inherits Devart.Data.SqlShimCommand
   Implements System.ComponentModel.IComponent, System.Data.IDbCommand, System.ICloneable, System.IDisposable

Remarks

The SugarCommand class provides the following methods for executing commands against SugarCRM:

Item	Description
ExecuteReader	Executes commands that return rows.
Devart.Common.DbCommandBase.ExecutePageReader	Returns a specific subset of rows when paging through the results of a query.
ExecuteNonQuery	Executes SQL commands such as INSERT, DELETE, UPDATE.
ExecuteScalar	Retrieves a single value (for example, an aggregate value) from a data source.

If execution of the command results in a fatal SugarException, the SugarConnection may close. However, the user can reopen the connection and continue.

Example

The following example uses the ExecuteReader method of SugarCommand, along with SugarDataReader and SugarConnection, to select rows from a table.

csharp

public void ReadMyData(string myConnString)
{
  string mySelectQuery = "SELECT id, name FROM Campaigns";
  SugarConnection sugarConnection = new SugarConnection(myConnString);
  SugarCommand sugarCommand = new SugarCommand(mySelectQuery,sugarConnection);
  sugarConnection.Open();
  SugarDataReader sugarReader = sugarCommand.ExecuteReader();
  try
  {
    while (sugarReader.Read())
    {
      Console.WriteLine(sugarReader.GetGuid(0).ToString() + ", " + sugarReader.GetString(1));
    }
  }
  finally
  {
  // always call Close when done reading.
  sugarReader.Close();
  // always call Close when done reading.
  sugarConnection.Close();
  }
}

Visual Basic

Public Sub ReadMyData(myConnString As String)
  Dim mySelectQuery As String = "SELECT id, name FROM Campaigns"
  Dim sugarConnection As New SugarConnection(myConnString)
  Dim sugarCommand As New SugarCommand(mySelectQuery, sugarConnection)
  sugarConnection.Open()
  Dim sugarReader As SugarDataReader = sugarCommand.ExecuteReader()
  Try
    While sugarReader.Read()
      Console.WriteLine(sugarReader.GetGuid(0).ToString() + ", " _
        + sugarReader.GetString(1))
    End While
  Finally
      ' always call Close when done reading.
      sugarReader.Close()
      ' always call Close when done with connection.
      sugarConnection.Close()
  End Try
End Sub

Inheritance Hierarchy

System.Object
   System.MarshalByRefObject
      System.ComponentModel.Component
         System.Data.Common.DbCommand
            Devart.Common.DbCommandBase
               Devart.Data.SqlShimCommand
                  Devart.Data.Sugar.SugarCommand

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

SugarCommand Members
Devart.Data.Sugar Namespace
SugarDataReader Class
SugarConnection Class

Send Feedback