Class SqlServerIdGenerator

The unique ID generator for Microsoft SQL Server.

Inheritance
System.Object
IdGeneratorBase
SqlServerIdGenerator
Implements
Inherited Members
Namespace: Kros.Data.SqlServer
Assembly: Kros.Utils.dll
Syntax
public class SqlServerIdGenerator : IdGeneratorBase, IIdGenerator, IDisposable
Remarks

In general, the generator should be created using SqlServerIdGeneratorFactory.

Examples
        public class PeopleService
    {
        private IIdGeneratorFactory _idGeneratorFactory;

        public PeopleService(IIdGeneratorFactory idGeneratorFactory)
        {
            _idGeneratorFactory = Check.NotNull(idGeneratorFactory, nameof(idGeneratorFactory));
        }

        public void GenerateData()
        {
            using (var idGenerator = _idGeneratorFactory.GetGenerator("people", 1000))
            {
                for (int i = 0; i < 1800; i++)
                {
                    var person = new Person()
                    {
                        Id = idGenerator.GetNext()
                    };
                }
            }
        }
    }

Constructors

SqlServerIdGenerator(SqlConnection, String, Int32)

Creates a generator for table tableName in database connection with batch size batchSize.

Declaration
public SqlServerIdGenerator(SqlConnection connection, string tableName, int batchSize)
Parameters
Type Name Description
System.Data.SqlClient.SqlConnection connection

Database connection.
System.String tableName

Table name, for which IDs are generated.
System.Int32 batchSize

IDs batch size. Saves round trips to database for IDs.
Exceptions
Type Condition
System.ArgumentNullException

Value of connection or tableName is null.
System.ArgumentException

Value of batchSize is less or equal than 0.

SqlServerIdGenerator(String, String, Int32)

Creates a generator for table tableName in database connectionString with batch size batchSize.

Declaration
public SqlServerIdGenerator(string connectionString, string tableName, int batchSize)
Parameters
Type Name Description
System.String connectionString

Connection string to the database.
System.String tableName

Table name, for which IDs are generated.
System.Int32 batchSize

IDs batch size. Saves round trips to database for IDs.
Exceptions
Type Condition
System.ArgumentNullException

Value of connectionString or tableName is null.
System.ArgumentException

Methods

CreateConnection(String)

Creates a database connection instance.

Declaration
protected override DbConnection CreateConnection(string connectionString)
Parameters
Type Name Description
System.String connectionString

Connection string.
Returns
Type Description
System.Data.Common.DbConnection

Specific instance of System.Data.Common.DbConnection.
Overrides

GetIdStoreTableCreationScript()

Returns SQL script for creating table in database for storing IDs.

Declaration
public static string GetIdStoreTableCreationScript()
Returns
Type Description
System.String

GetNewIdFromDbCore()

Returns new ID from database. In this method is ensured, that the Connection is opened.

Declaration
protected override int GetNewIdFromDbCore()
Returns
Type Description
System.Int32

Next ID.
Overrides

GetStoredProcedureCreationScript()

Returns SQL script for creating stored procedure, which generates IDs.

Declaration
public static string GetStoredProcedureCreationScript()
Returns
Type Description
System.String

InitDatabaseForIdGenerator()

Initializes database for using ID generator. Initialization can mean creating necessary table and stored procedure.

Declaration
public override void InitDatabaseForIdGenerator()
Overrides

Implements

See Also