docs/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-sqlserver.md

type	title	linkTitle	description	aliases
docs	SQL Server	SQL Server	Detailed information on the SQL Server state store component	/operations/components/setup-state-store/supported-state-stores/setup-sqlserver/

Component format

To setup SQL Server state store create a component of type state.sqlserver. See [this guide]({{< ref "howto-get-save-state.md#step-1-setup-a-state-store" >}}) on how to create and apply a state store configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
  name: <NAME>
  namespace: <NAMESPACE>
spec:
  type: state.sqlserver
  version: v1
  metadata:
  - name: connectionString
    value: <REPLACE-WITH-CONNECTION-STRING> # Required.
  - name: tableName
    value: <REPLACE-WITH-TABLE-NAME>  # Optional. defaults to "state"
  - name: keyType
    value: <REPLACE-WITH-KEY-TYPE>  # Optional. defaults to "string"
  - name: keyLength
    value: <KEY-LENGTH> # Optional. defaults to 200. Yo be used with "string" keyType
  - name: schema
    value: <SCHEMA> # Optional. defaults to "dbo"
  - name: indexedProperties
    value: <INDEXED-PROPERTIES> # Optional. List of IndexedProperties.

{{% alert title="Warning" color="warning" %}} The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described [here]({{< ref component-secrets.md >}}). {{% /alert %}}

If you wish to use SQL server as an [actor state store]({{< ref "state_api.md#configuring-state-store-for-actors" >}}), append the following to the yaml.

  - name: actorStateStore
    value: "true"

Spec metadata fields

Field	Required	Details	Example
connectionString	Y	The connection string used to connect. If the connection string contains the database it must already exist. If the database is omitted a default database named "Dapr" is created.	"Server=myServerName\myInstanceName;Database=myDataBase;User Id=myUsername;Password=myPassword;"
tableName	N	The name of the table to use. Alpha-numeric with underscores. Defaults to "state"	"table_name"
keyType	N	The type of key used. Defaults to "string"	"string"
keyLength	N	The max length of key. Used along with "string" keytype. Defaults to "200"	"200"
schema	N	The schema to use. Defaults to "dbo"	"dapr","dbo"
indexedProperties	N	List of IndexedProperties.	'[{"column": "transactionid", "property": "id", "type": "int"}, {"column": "customerid", "property": "customer", "type": "nvarchar(100)"}]'
actorStateStore	N	Indicates that Dapr should configure this component for the actor state store ([more information]({{< ref "state_api.md#configuring-state-store-for-actors" >}})).	"true"

Create Azure SQL instance

Follow the instructions from the Azure documentation on how to create a SQL database. The database must be created before Dapr consumes it.

Note: SQL Server state store also supports SQL Server running on VMs and in Docker.

In order to setup SQL Server as a state store, you need the following properties:

• Connection String: The SQL Server connection string. For example: server=localhost;user id=sa;password=your-password;port=1433;database=mydatabase;
• Schema: The database schema to use (default=dbo). Will be created if does not exist
• Table Name: The database table name. Will be created if does not exist
• Indexed Properties: Optional properties from json data which will be indexed and persisted as individual column

Create a dedicated user

When connecting with a dedicated user (not sa), these authorizations are required for the user - even when the user is owner of the desired database schema:

• CREATE TABLE
• CREATE TYPE

Related links

• [Basic schema for a Dapr component]({{< ref component-schema >}})
• Read [this guide]({{< ref "howto-get-save-state.md#step-2-save-and-retrieve-a-single-state" >}}) for instructions on configuring state store components
• [State management building block]({{< ref state-management >}})