Use Microsoft SQL Server records
Use records from a Microsoft SQL Server table as input to ArcGIS Data Pipelines.
Usage notes
Keep the following in mind when working with SQL Server:
To use a dataset from SQL Server, you must first create a data store item. Data store items securely store credentials and connection information so the data can be read by Data Pipelines. To create a data store, use one of the following methods:
Use the Data Pipelines editor—To create a data store in the editor, follow the steps in the Connect to SQL Server section below.
Use the Content page—To create a data store in Content, see Add a database data store item.
To change the data store item you configured, use the Data store item parameter to remove the currently selected item, and choose one of the following options:
Add data store—Create a new data store item.
Select item—Browse your content to select an existing data store item.
Specify the dataset using the Schema parameter, and use the Table parameter to specify the table containing the data you want to use. Schema and table names are case sensitive. For example, if the table is named MyTable, you must specify it using the exact capitalization.
To improve the performance of reading input datasets, consider the following options:
Use the Use caching parameter to store a copy of the dataset. The cached copy is only maintained while at least one browser tab open to the editor is connected. This may make it faster to access the data during processing. If the source data has been updated since it was cached, uncheck this parameter and preview or run the tool again.
After configuring an input dataset, configure any of the following tools that limit the amount of data being processed:
Filter by attribute—Maintain a subset of records that contain certain attribute values.
Filter by extent—Maintain a subset of records within a certain spatial extent.
Select fields—Maintain only the fields of interest.
Clip—Maintain a subset of records that intersect with specific geometries.
Connect to SQL Server
To use data stored in SQL Server, complete the following steps to create a data store item in the Data Pipelines editor:
On the Data Pipelines editor toolbar, click Inputs and choose Microsoft SQL Server.
The Select a data store connection dialog box appears.
Choose Add new.
Click Next.
The Connect to a data store dialog box appears.
Provide the SQL Server instance name in the Instance text box.
Provide a valid username and password in the Username and Password text boxes, respectively.
Choose the name of the database you want to connect to on the instance.
Click Next.
Accept the default geodatabase connection properties or update the properties as needed for your environment.
Click Next.
Select the Data Pipelines Server site (Data Pipelines) with which this data store will be registered. This is required to access your data in Data Pipelines. Optionally, choose to register the data store with additional server sites.
Click Next.
The item details pane appears.
Provide a title for the new data store item.
This title will appear in your portal content. You can also store the item in a specific folder and provide item tags or a summary.
Click Create connection to create the data store item.
The Select datasets dialog box appears.
Provide the name of the schema that contains the table to use.
Provide the name of the table to use as an input dataset in the data pipeline.
Click Add.
A SQL Server element is added to the canvas.
Limitations
The following are known limitations:
- Data Pipelines only supports the Database authentication type for SQL Server. If your data store is configured to use another authentication type, it will not work as input to Data Pipelines.
Licensing requirements
The following licensing and configurations are required:
Creator or Professional user type
Publisher or Administrator role, or an equivalent custom role
To learn more about Data Pipelines requirements, see Requirements.
Additionally, Data Pipelines is only available if you have an ArcGIS Data Pipelines Server configured with ArcGIS Enterprise.
Related topics
See the following for additional information:
To learn more about SQL Server connections in ArcGIS Pro, see Connect to Microsoft SQL Server from ArcGIS.
To learn more about adding data store items to your content, see Add a data store item.