Извлечение значений идентификаторов или автонумерации

Статья
05/23/2023

Применимо: платформа .NET Framework .NET Standard

Первичным ключом в реляционной базе данных является столбец или сочетание столбцов, которые всегда содержат уникальные значения. Если известно значение первичного ключа, то можно найти строку, которая содержит это значение. Такие СУРБД, как SQL Server, Oracle и Microsoft Access/Jet, поддерживают создание столбцов с автоматически увеличивающимися значениями, которые могут назначаться в качестве первичных ключей. Эти значения формируются сервером по мере добавления строк в таблицу. В SQL Server задается свойство идентификатора столбца, в Oracle создается последовательность Sequence, а в Microsoft Access создается столбец AutoNumber.

Для формирования автоматически увеличивающихся значений также можно использовать объект DataColumn, присвоив его свойству AutoIncrement значение true. Но это может привести к появлению повторяющихся значений в отдельных экземплярах DataTable, если в нескольких клиентских приложениях будут независимо формироваться автоматически увеличивающиеся значения. Применение сервера для формирования автоматически увеличивающихся значений позволяет устранить потенциальные конфликты, поскольку каждый пользователь может получать создаваемые сервером значения для каждой вставляемой строки.

Во время вызова метода Update объекта DataAdapter база данных может отправлять данные обратно в приложение ADO.NET в качестве выходных параметров или в виде первой возвращенной записи результирующего набора инструкции SELECT, выполняемой в том же пакете, что и инструкция INSERT. Поставщик данных Microsoft SqlClient для SQL Server может извлекать эти значения и обновлять соответствующие столбцы в обновляемой DataRow.

Примечание.

Подход, альтернативный по отношению к использованию автоматически увеличивающегося значения, состоит в применении метода NewGuid объекта Guid для формирования идентификатора GUID (глобально уникального идентификатора) на клиентском компьютере, который может копироваться на сервер при вставке каждой новой строки. Метод NewGuid формирует 16-байтовое двоичное значение с помощью алгоритма, который обеспечивает высокую вероятность того, что ни одно из полученных значений не будет повторяться. В базе данных SQL Server идентификатор GUID хранится в столбце uniqueidentifier, который может автоматически создаваться в SQL Server с помощью функции NEWID() языка Transact-SQL. Использование идентификатора GUID в качестве первичного ключа может привести к снижению производительности. SQL Server обеспечивает поддержку функции NEWSEQUENTIALID(), создающей последовательные значения идентификатора GUID, глобальная уникальность которых не гарантируется, но которые можно более эффективно индексировать.

Извлечение значений столбца идентификаторов SQL Server

При работе с Microsoft SQL Server можно создать хранимую процедуру с выходным параметром, возвращающим значение идентификатора для вставленной строки. В следующей таблице описаны три функции Transact-SQL, применимые в SQL Server, с помощью которых можно извлекать значения столбцов идентификаторов.

Function	Description
SCOPE_IDENTITY	Возвращает последнее значение идентификатора в текущей области выполнения. В большинстве случаев рекомендуется использовать SCOPE_IDENTITY.
@@IDENTITY	Содержит последнее значение идентификатора, сформированного в любой таблице в текущем сеансе. @@IDENTITY может влиять на триггеры и может не возвращать ожидаемое значение удостоверения.
IDENT_CURRENT	Возвращает последнее значение идентификатора, сформированное для указанной таблицы в любом сеансе и любой области.

Следующая хранимая процедура показывает, как вставить строку в таблицу Categories и использовать выходной параметр для возврата нового значения идентификатора, сформированного функцией SCOPE_IDENTITY() языка Transact-SQL.

CREATE PROCEDURE dbo.InsertCategory
  @CategoryName nvarchar(15),
  @Identity int OUT
AS
INSERT INTO Categories (CategoryName) VALUES(@CategoryName)
SET @Identity = SCOPE_IDENTITY()

После этого данную хранимую процедуру можно указать в качестве источника InsertCommand объекта SqlDataAdapter. Свойство CommandType объекта InsertCommand должно иметь значение StoredProcedure. Получение выходного значения идентификатора осуществляется путем создания объекта SqlParameter, который имеет свойство ParameterDirection со значением Output. При обработке InsertCommand возвращается автоматически увеличивающееся значение идентификатора, которое размещается в столбце CategoryID текущей строки, если свойство UpdatedRowSource команды вставки имеет значение UpdateRowSource.OutputParameters или UpdateRowSource.Both.

Если в команде вставки выполняется пакет, который включает и инструкцию INSERT, и инструкцию SELECT, возвращающую новое значение идентификатора, то это новое значение можно получить, задав свойство UpdatedRowSource команды вставки, равное UpdateRowSource.FirstReturnedRecord.

private static void RetrieveIdentity(string connectionString)
{
    using (SqlConnection connection = new SqlConnection(connectionString))
    {
        // Create a SqlDataAdapter based on a SELECT query.
        SqlDataAdapter adapter = new SqlDataAdapter(
            "SELECT CategoryID, CategoryName FROM dbo.Categories",
            connection);

        //Create the SqlCommand to execute the stored procedure.
        adapter.InsertCommand = new SqlCommand("dbo.InsertCategory",
            connection);
        adapter.InsertCommand.CommandType = CommandType.StoredProcedure;

        // Add the parameter for the CategoryName. Specifying the
        // ParameterDirection for an input parameter is not required.
        adapter.InsertCommand.Parameters.Add(
           new SqlParameter("@CategoryName", SqlDbType.NVarChar, 15,
           "CategoryName"));

        // Add the SqlParameter to retrieve the new identity value.
        // Specify the ParameterDirection as Output.
        SqlParameter parameter =
            adapter.InsertCommand.Parameters.Add(
            "@Identity", SqlDbType.Int, 0, "CategoryID");
        parameter.Direction = ParameterDirection.Output;

        // Create a DataTable and fill it.
        DataTable categories = new DataTable();
        adapter.Fill(categories);

        // Add a new row.
        DataRow newRow = categories.NewRow();
        newRow["CategoryName"] = "New Category";
        categories.Rows.Add(newRow);

        adapter.Update(categories);

        Console.WriteLine("List All Rows:");
        foreach (DataRow row in categories.Rows)
        {
            {
                Console.WriteLine("{0}: {1}", row[0], row[1]);
            }
        }
    }
}

Объединение новых значений идентификаторов

Распространенный сценарий состоит в вызове метода GetChanges объекта DataTable для создания копии, которая содержит только изменившиеся строки, после чего эта новая копия используется при вызове метода Update объекта DataAdapter. Это особенно удобно, если требуется маршалировать и передать изменившиеся строки для отдельного компонента, который выполняет обновление. После обновления эта копия может содержать новые значения идентификаторов, которые затем должны быть переданы обратно в оригинал DataTable для слияния. Причем новые значения идентификаторов, по всей вероятности, будут отличаться от исходных значений в DataTable. Чтобы можно было выполнить это слияние, необходимо сохранить первоначальные значения столбцов AutoIncrement в копии, чтобы иметь возможность находить и обновлять существующие строки в оригинале DataTable, а не добавлять новые строки, содержащие новые значения идентификаторов. Однако по умолчанию эти первоначальные значения теряются после вызова метода Update объекта DataAdapter, поскольку для каждой обновляемой строки AcceptChanges неявно вызывается метод DataRow.

Существует два способа сохранения первоначальных значений DataColumn в объекте DataRow во время обновления DataAdapter.

Первый способ сохранения первоначальных значений состоит в присвоении свойству AcceptChangesDuringUpdate объекта DataAdapter значения false. Это влияет на каждый объект DataRow в обновляемом объекте DataTable. Дополнительные сведения и пример кода см. в разделе AcceptChangesDuringUpdate.
Второй способ предусматривает применение в обработчике событий RowUpdated объекта DataAdapter кода, в котором свойству Status присваивается значение SkipCurrentRow. Значение DataRow обновляется, но первоначальное значение каждого объекта DataColumn сохраняется. Этот способ позволяет сохранять первоначальные значения одних строк, но не других. Например, в коде можно сохранить первоначальные значения добавляемых строк, а не изменяемых или удаляемых строк путем проверки значения StatementType с последующим присваиванием свойству Status значения SkipCurrentRow только для строк со свойством StatementType равным Insert.

Если любой из этих способов используется для сохранения первоначальных значений в объекте DataRow во время обновления DataAdapter, в адаптере обработки данных Microsoft SqlClient для SQL Server выполняется ряд действий по замене текущих значений DataRow на новые значения, возвращаемые в качестве выходных параметров или в виде первой возвращаемой строки результирующего набора, с сохранением первоначального значения в каждом объекте DataColumn. Сначала вызывается метод AcceptChanges объекта DataRow для сохранения текущих значений в качестве первоначальных значений, а затем присваиваются новые значения. После этого у объектов DataRows, у которых свойство RowState равно Added, значение этого свойства RowState заменяется на Modified, что может не соответствовать ожиданиям.

Способ применения результатов команды к каждому обновляемому объекту DataRow определяется свойством UpdatedRowSource каждой команды DbCommand. Это свойство задается равным одному из значений из перечисления UpdateRowSource.

В следующей таблице приведено описание того, как значения перечисления UpdateRowSource влияют на свойство RowState обновленных строк.

Имя участника	Description
Both	Вызывается метод `AcceptChanges`, после чего значения выходных параметров и (или) значения из первой строки любого возвращенного результирующего набора помещаются в обновляемый объект `DataRow`. Если применимые значения отсутствуют, то `RowState` становится равным Unchanged.
FirstReturnedRecord	Если возвращена строка, вызывается метод `AcceptChanges`, и эта строка сопоставляется с измененной строкой в `DataTable`, в связи с чем свойству `RowState` присваивается значение `Modified`. Если не возвращена ни одна строка, то метод `AcceptChanges` не вызывается, и `RowState` остается равным `Added`.
None	Любые возвращенные параметры или строки пропускаются. Метод `AcceptChanges` не вызывается, и `RowState` остается равным `Added`.
OutputParameters	Вызывается метод `AcceptChanges`, и все выходные параметры сопоставляются с измененной строкой в `DataTable`, в связи с чем свойству `RowState` присваивается значение `Modified`. Если выходные параметры отсутствуют, то `RowState` становится равным `Unchanged`.

Пример

В этом примере демонстрируется извлечение измененных строк из DataTable и использование объекта SqlDataAdapter для обновления источника данных и получения нового значения столбца идентификаторов. В InsertCommand выполняются две инструкции Transact-SQL; первая из них представляет собой инструкцию INSERT, а вторая является инструкцией SELECT, в которой для получения значения идентификатора используется функция SCOPE_IDENTITY.

INSERT INTO dbo.Shippers (CompanyName)
VALUES (@CompanyName);
SELECT ShipperID, CompanyName FROM dbo.Shippers
WHERE ShipperID = SCOPE_IDENTITY();

Свойство UpdatedRowSource команды вставки задается равным UpdateRowSource.FirstReturnedRow, а свойство MissingSchemaAction объекта DataAdapter задается равным MissingSchemaAction.AddWithKey. Объект DataTable заполняется, и в коде происходит добавление новой строки к DataTable. Затем измененные строки извлекаются в новый объект DataTable, передаваемый в DataAdapter, с помощью которого после этого происходит обновление на сервере.

private static void MergeIdentityColumns(string connectionString)
{
    using (SqlConnection connection = new SqlConnection(connectionString))
    {
        // Create the DataAdapter
        SqlDataAdapter adapter = new SqlDataAdapter(
            "SELECT ShipperID, CompanyName FROM dbo.Shippers",
            connection);

        //Add the InsertCommand to retrieve new identity value.
        adapter.InsertCommand = new SqlCommand(
            "INSERT INTO dbo.Shippers (CompanyName) " +
            "VALUES (@CompanyName); " +
            "SELECT ShipperID, CompanyName FROM dbo.Shippers " +
            "WHERE ShipperID = SCOPE_IDENTITY();", connection);

        // Add the parameter for the inserted value.
        adapter.InsertCommand.Parameters.Add(
           new SqlParameter("@CompanyName", SqlDbType.NVarChar, 40,
           "CompanyName"));
        adapter.InsertCommand.UpdatedRowSource = UpdateRowSource.Both;

        // MissingSchemaAction adds any missing schema to
        // the DataTable, including identity columns
        adapter.MissingSchemaAction = MissingSchemaAction.AddWithKey;

        // Fill the DataTable.
        DataTable shipper = new DataTable();
        adapter.Fill(shipper);

        // Add a new shipper.
        DataRow newRow = shipper.NewRow();
        newRow["CompanyName"] = "New Shipper";
        shipper.Rows.Add(newRow);

        // Add changed rows to a new DataTable. This
        // DataTable will be used by the DataAdapter.
        DataTable dataChanges = shipper.GetChanges();

        // Add the event handler.
        adapter.RowUpdated +=
            new SqlRowUpdatedEventHandler(OnRowUpdated);

        adapter.Update(dataChanges);
        connection.Close();

        // Merge the updates.
        shipper.Merge(dataChanges);

        // Commit the changes.
        shipper.AcceptChanges();

        Console.WriteLine("Rows after merge.");
        foreach (DataRow row in shipper.Rows)
        {
            {
                Console.WriteLine("{0}: {1}", row[0], row[1]);
            }
        }
    }
}

В обработчике событий OnRowUpdated проверяется значение StatementType свойства SqlRowUpdatedEventArgs, чтобы определить, была ли вставлена данная строка. Если результат этой проверки является положительным, то свойство Status задается равным SkipCurrentRow. Строка обновляется, но первоначальные значения в строке сохраняются. В основной части рассматриваемой процедуры вызывается метод Merge для слияния нового значения идентификатора с оригинальным значением DataTable, и в конечном счете вызывается метод AcceptChanges.

protected static void OnRowUpdated(
    object sender, SqlRowUpdatedEventArgs e)
{
    // If this is an insert, then skip this row.
    if (e.StatementType == StatementType.Insert)
    {
        e.Status = UpdateStatus.SkipCurrentRow;
    }
}