commands

^

New-DbaDbSequence

Author Adam Lancaster https://github.com/lancasteradam
Availability Windows, Linux, macOS

 

Synopsis

Creates a sequence.

Description

Creates a sequence in the database(s) specified. SQL Server 2012 and higher are supported.

Syntax

New-DbaDbSequence
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Database] <String[]>]
    [-Name] <String>
    [[-Schema] <String>]
    [[-IntegerType] <String>]
    [[-StartWith] <Int64>]
    [[-IncrementBy] <Int64>]
    [[-MinValue] <Int64>]
    [[-MaxValue] <Int64>]
    [-Cycle]
    [[-CacheSize] <Int32>]
    [[-InputObject] <Database[]>]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> New-DbaDbSequence -SqlInstance sqldev01 -Database TestDB -Name TestSequence -StartWith 10000 -IncrementBy 10

Creates a new sequence TestSequence in the TestDB database on the sqldev01 instance. The sequence will start with 10000 and increment by 10.

Example: 2
PS C:\> New-DbaDbSequence -SqlInstance sqldev01 -Database TestDB -Name TestSequence -Cycle

Creates a new sequence TestSequence in the TestDB database on the sqldev01 instance. The sequence will cycle the numbers.

Example: 3
PS C:\> Get-DbaDatabase -SqlInstance sqldev01 -Database TestDB | New-DbaDbSequence -Name TestSequence -Schema TestSchema -IntegerType bigint

Using a pipeline this command creates a new bigint sequence named TestSchema.TestSequence in the TestDB database on the sqldev01 instance.

Required Parameters

-Name

The name of the new sequence

Alias
Required True
Pipeline false
Default Value

Optional Parameters

-SqlInstance

The target SQL Server instance or instances. This can be a collection and receive pipeline input to allow the function to be executed against multiple SQL Server instances.

Alias
Required False
Pipeline false
Default Value
-SqlCredential

Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential). Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported. For MFA support, please use Connect-DbaInstance.

Alias
Required False
Pipeline false
Default Value
-Database

The target database(s).

Alias
Required False
Pipeline false
Default Value
-Schema

The name of the schema for the sequence. The default is dbo.

Alias
Required False
Pipeline false
Default Value dbo
-IntegerType

The integer type for the sequence. The default is bigint. User defined integer types can be used.

Alias
Required False
Pipeline false
Default Value bigint
-StartWith

The first value for the sequence to start with. The default is 1.

Alias
Required False
Pipeline false
Default Value 1
-IncrementBy

The value to increment by. The default is 1.

Alias
Required False
Pipeline false
Default Value 1
-MinValue

The minimum bound for the sequence.

Alias
Required False
Pipeline false
Default Value 0
-MaxValue

The maximum bound for the sequence.

Alias
Required False
Pipeline false
Default Value 0
-Cycle

Switch parameter that indicates if the sequence should cycle the values

Alias
Required False
Pipeline false
Default Value False
-CacheSize

The integer size of the cache. To specify NO CACHE for a sequence use -CacheSize 0. As noted in the Microsoft documentation if the cache size is not specified the Database Engine will select a size.

Alias
Required False
Pipeline false
Default Value 0
-InputObject

Allows piping from Get-DbaDatabase.

Alias
Required False
Pipeline true (ByValue)
Default Value
-EnableException

By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.

Alias
Required False
Pipeline false
Default Value False
-WhatIf

Shows what would happen if the command were to run. No actions are actually performed.

Alias wi
Required False
Pipeline false
Default Value
-Confirm

Prompts you for confirmation before executing any changing operations within the command.

Alias cf
Required False
Pipeline false
Default Value

 

Want to see the source code for this command? Check out New-DbaDbSequence on GitHub.
Want to see the Bill Of Health for this command? Check out New-DbaDbSequence.