Network Share SMB Connector for Data Prep¶
User Persona: Data Prep User, Data Prep Admin, Data Source Admin, or IT/DevOps
Note
This document covers all configuration fields available during connector setup. Some fields may have already been filled out by your Administrator at an earlier step of configuration and may not be visible to you. For more information on Data Prep's connector framework, see Data Prep Connector setup. Also, your Admin may have named this connector something else in the list of Data Sources.
Configure Data Prep¶
This connector allows you to connect to a network share using Server Message Block (SMB) protocol for imports and exports. The following fields are used to define the connection parameters.
General¶
-
Name: Name of the data source as it will appear to users in the UI.
-
Description: Description of the data source as it will appear to users in the UI.
Tip
You can connect Data Prep to multiple SMB shares. Using a descriptive name can be a big help to users in identifying the appropriate data source.
Configuration¶
-
Share Hostname: is the server hostname.
-
Share Port: is the server port number. The default SMB port is 445.
-
Share Name: is the name of the share. The name of the share that the user intends to use for import or export. The Share Name is not a path and must not contain ‘\’ characters. Space characters are allowed.
Credentials¶
User authentication can be done through a shared account or an individual account. If credentials are not configured with the Data Source, the user will be prompted for credentials.
-
Username: The username used to authenticate on the share.
-
Password: The password used to authenticate on the share.
-
User Domain: The user's domain for connecting to the share.
-
Also known as the SMB Workgroup.
-
In an AD/LDAP-managed account, this is the AD domain to which the account belongs.
- Domain account structure:
\
- Domain account structure:
-
For non AD/LDAP-managed account, Domain can be blank.
-
Timeouts¶
- Read/Write Timeout: The timeout (in seconds) for reading/writing from/to the share.
Data Import Information¶
Via Browsing¶
Browse directories and files within the configured Share.
Via SQL Query¶
As SMB is a file store, SQL Queries are not supported for this data source.
FAQ/Troubleshooting/Common Issues¶
Data Prep tests this Connector against Windows Shares (read-only and read/write) using LDAP and Linux Shares using local server accounts. There are many ways to host and configure an SMB service and this sometimes can cause issues establishing a connection. When there are issues, please ask your administrator for a copy of the configuration file for the server (with sensitive values removed) and a copy of the log output for the server as well.