Метод SqlCeCommand.SetRange

  • Статья

Ограничивает набор строк, считываемых экземпляром SqlCeDataReader.

Пространство имен:  System.Data.SqlServerCe
Сборка:  System.Data.SqlServerCe (в System.Data.SqlServerCe.dll)

Синтаксис

'Декларация
Public Sub SetRange ( _
    dbRangeOptions As DbRangeOptions, _
    startData As Object(), _
    endData As Object() _
)
'Применение
Dim instance As SqlCeCommand
Dim dbRangeOptions As DbRangeOptions
Dim startData As Object()
Dim endData As Object()

instance.SetRange(dbRangeOptions, startData, _
    endData)

public void SetRange(
    DbRangeOptions dbRangeOptions,
    Object[] startData,
    Object[] endData
)

public:
void SetRange(
    DbRangeOptions dbRangeOptions, 
    array<Object^>^ startData, 
    array<Object^>^ endData
)

member SetRange : 
        dbRangeOptions:DbRangeOptions * 
        startData:Object[] * 
        endData:Object[] -> unit 

public function SetRange(
    dbRangeOptions : DbRangeOptions, 
    startData : Object[], 
    endData : Object[]
)

Параметры

  • startData
    Тип: array<System.Object[]
    Начальные значения ключа для диапазона.
  • endData
    Тип: array<System.Object[]
    Конечные значения ключа для диапазона.

Исключения

Исключение Условие
InvalidOperationException

Не задано значение свойства IndexName.

Замечания

Этот метод при выборке строк из базовой таблицы работает быстрее, чем инструкция SELECT. По сравнению с предложением WHERE в инструкции SELECT метод SetRange быстрее выбирает набор строк по значениям индекса. Например, чтобы выбрать сведения о сотрудниках с идентификаторами от 1 до 5, можно выполнить соответствующую инструкцию SELECT, однако задание диапазона значений индекса от 1 до 5 для столбца с идентификаторами сотрудников позволяет существенно повысить производительность.

Этот метод можно использовать, только если свойство CommandType имеет значение TableDirect, свойство CommandText содержит допустимое имя базовой таблицы, а свойство IndexName содержит допустимое имя индекса для заданной базовой таблицы. Если используется SetRange, то объект SqlCeDataReader, возвращаемый методом ExecuteReader, будет возвращать только строки, для которых ключевые значения в заданном индексе попадают в диапазон.

При вызове метода Seek для экземпляра SqlCeDataReader с заданным диапазоном производится позиционирование только для строк в этом диапазоне. Дополнительные сведения о методе SetRange см. в разделе «IRowsetIndex::SetRange» документации по OLE DB.

Примеры

В следующем примере осуществляется выборка данных по индексу из таблицы Orders в объект SqlCeDataReader. Диапазон индекса для метода Seek, заданный методом SetRange.

        Try
            Dim conn As New SqlCeConnection("Data Source = MyDatabase.sdf")
            conn.Open()

            Dim cmd As SqlCeCommand = conn.CreateCommand()
            cmd.CommandType = CommandType.TableDirect
            cmd.IndexName = "Orders_PK"
            cmd.CommandText = "Orders"

            ' We are interested in orders that match Order ID = 10020
            '
            cmd.SetRange(DbRangeOptions.Match, New Object() {10020}, Nothing)

            Dim reader As SqlCeDataReader = cmd.ExecuteReader(CommandBehavior.Default)

            While reader.Read()
                MessageBox.Show(String.Format("{0} ; {1}", reader("Order ID"), reader("Order Date")))
            End While

            ' Now we are interested in orders with Order ID between (10020, 10050)
            '
            cmd.SetRange(DbRangeOptions.InclusiveStart Or DbRangeOptions.InclusiveEnd, New Object() {10020}, New Object() {10050})

            reader = cmd.ExecuteReader(CommandBehavior.Default)

            ' Now seek to Order ID = 10045
            '
            Dim onRow As Boolean =  reader.Seek(DbSeekOptions.FirstEqual, New Object() {10045})

            ' Now ,the reader will return rows with Order ID >= 10045 <= 10050
            ' because the range was set to (10020, 10050)
            '
            If onRow Then
                While reader.Read()
                    MessageBox.Show(String.Format("{0} ; {1}", reader("Order ID"), reader("Order Date")))
                End While
            End If
        Catch e As Exception
            MessageBox.Show(e.Message)
        End Try

        try
        {
            SqlCeConnection conn = new SqlCeConnection("Data Source = MyDatabase.sdf");
            conn.Open();

            SqlCeCommand cmd = conn.CreateCommand();
            cmd.CommandType = CommandType.TableDirect;
            cmd.IndexName = "Orders_PK";
            cmd.CommandText = "Orders";

            // We are interested in orders that match Order ID = 10020
            //
            cmd.SetRange(DbRangeOptions.Match, new object[] { 10020 }, null);

            SqlCeDataReader reader = cmd.ExecuteReader(CommandBehavior.Default);

            for (int i = 1; reader.Read(); i++)
            {
                MessageBox.Show(String.Format("{0} ; {1}", reader["Order ID"], reader["Order Date"]));
            }

            // Now we are interested in orders with Order ID between (10020, 10050)
            //
            cmd.SetRange(DbRangeOptions.InclusiveStart | DbRangeOptions.InclusiveEnd,
                new object[] { 10020 }, new object[] { 10050 });

            reader = cmd.ExecuteReader(CommandBehavior.Default);

            // Now seek to Order ID = 10045
            //
            bool onRow = reader.Seek(DbSeekOptions.FirstEqual, new object[] { 10045 });

            // Now ,the reader will return rows with Order ID >= 10045 <= 10050
            // because the range was set to (10020, 10050)
            //
            if (onRow)
            {
                for (int i = 1; reader.Read(); i++)
                {
                    MessageBox.Show(String.Format("{0} ; {1}", reader["Order ID"], reader["Order Date"]));
                }
            }
        }
        catch (Exception e)
        {
            MessageBox.Show(e.Message);
        }

См. также

Справочник

SqlCeCommand Класс

Пространство имен System.Data.SqlServerCe