Establishing a Connection
Connecting to Excel Data Sources
The CData ADO.NET Provider for Excel allows connecting to local and remote Excel resources. Set the URI property to the Excel resource location, in addition to any other properties necessary to connect to your data source.
| Service provider | URI formats | InitiateOAuth | OAuthClientId | OAuthClientSecret | OAuthAccessToken | OAuthAccessTokenSecret | User | Password | AuthScheme | AzureAccount | AzureAccessKey | AWSAccessKey | AWSSecretKey | AWSRegion | AccessKey | SecretKey | Region | OracleNamespace | ProjectId |
| Local | localPath
file://localPath | ||||||||||||||||||
| HTTP or HTTPS | http://remoteStream
https://remoteStream | OPTIONAL | OPTIONAL | OPTIONAL | |||||||||||||||
| Amazon S3 | s3://remotePath | REQUIRED (your AccessKey) | REQUIRED (your SecretKey) | OPTIONAL | |||||||||||||||
| Azure Blob Storage | azureblob://mycontainer/myblob/ | REQUIRED | REQUIRED (your AccessKey) | ||||||||||||||||
| Azure Data Lake Store Gen1 | adl://remotePath
adl://Account.azuredatalakestore.net@remotePath | REQUIRED | OPTIONAL | OPTIONAL | OPTIONAL | REQUIRED | REQUIRED | ||||||||||||
| Azure Data Lake Store Gen2 | abfs://myfilesystem/remotePath | REQUIRED | REQUIRED (your AccessKey) | ||||||||||||||||
| Azure Data Lake Store Gen2 with SSL | abfss://myfilesystem/remotePath | REQUIRED | REQUIRED (your AccessKey) | ||||||||||||||||
| Google Drive | gdrive://remotePath | OPTIONAL | OPTIONAL | OPTIONAL | OPTIONAL | OPTIONAL | REQUIRED | ||||||||||||
| OneDrive | onedrive://remotePath | OPTIONAL | OPTIONAL | OPTIONAL | OPTIONAL | OPTIONAL | REQUIRED | ||||||||||||
| Box | box://remotePath | OPTIONAL | REQUIRED | REQUIRED | OPTIONAL | OPTIONAL | REQUIRED | ||||||||||||
| Dropbox | dropbox://remotePath | OPTIONAL | REQUIRED | REQUIRED | OPTIONAL | OPTIONAL | REQUIRED | ||||||||||||
| SharePoint Online SOAP | sp://remotePath | REQUIRED | REQUIRED | ||||||||||||||||
| SharePoint Online REST | sprest://remotePath | OPTIONAL | OPTIONAL | OPTIONAL | OPTIONAL | REQUIRED | |||||||||||||
| FTP or FTPS | ftp://server:port/remotePath
ftps://server:port/remotepath | REQUIRED | REQUIRED | ||||||||||||||||
| SFTP | sftp://server:port/remotePath | OPTIONAL | OPTIONAL | ||||||||||||||||
| Wasabi | wasabi://bucket1/remotePath; | REQUIRED (your AccessKey) | REQUIRED (your SecretKey) | OPTIONAL | |||||||||||||||
| Google Cloud Storage | gs://bucket/remotePath; | OPTIONAL | OPTIONAL | OPTIONAL | OPTIONAL | OPTIONAL | REQUIRED | REQUIRED | |||||||||||
| Oracle Cloud Storage | os://bucket/remotePath; | REQUIRED (your AccessKey) | REQUIRED (your SecretKey) | OPTIONAL | REQUIRED |
Connecting to a Workbook
The ExcelFile, under the Connection section, must be set to a valid Excel File (including the file path). The provider supports the Office Open XML format used by Excel 2007 and later.
Querying a Workbook
You can then execute SELECT, INSERT, UPDATE, and DELETE statements to spreadsheets and ranges in the workbook. See Excel Operations for details on querying spreadsheet data as tables.
Connecting to Amazon S3
Set the URI to an Excel file in a bucket. Additionally, set the following properties to authenticate:
- AWSAccessKey: Set this to an Amazon Web Services Access Key (a username).
- AWSSecretKey: Set this to an Amazon Web Services Secret Key.
URI=s3://bucket1/folder1/file.xlsx; AWSAccessKey=token1; AWSSecretKey=secret1; AWSRegion=OHIO;
Optionally, specify AWSRegion in addition.
Note: It is also possible to connect to S3-compatible services by specifying its base Url. For example, if the Url conn prp is set to http://s3.%region%.myservice.com and Region is region-1, then we will generate request URLs like https://s3.region-1.myservice.com/bucket/... (or like https://bucket.s3.region-1.myservice.com/..., if the UseVirtualHosting property is true).
Connecting to Oracle Cloud Object Storage
Set the URI to an Excel file in a bucket. Additionally, set the following properties to authenticate:
- AccessKey: Set this to an Oracle cloud Access Key.
- SecretKey: Set this to an Oracle cloud Secret Key.
- OracleNamespace: Set this to an Oracle cloud namespace.
URI=os://bucket/remotePath/; AccessKey=token1; SecretKey=secret1; OracleNamespace=myNamespace; Region=us-ashburn-1;
Optionally, specify Region in addition.
Connecting to Wasabi
Set the URI to an Excel file in a bucket. Additionally, set the following properties to authenticate:
- AWSAccessKey: Set this to a Wasabi Access Key (a username)
- AWSSecretKey: Set this to a Wasabi Secret Key.
For example:
URI=wasabi://bucket1/folder1/file.xlsx; AWSAccessKey=token1; AWSSecretKey=secret1; AWSRegion=OHIO;
Connect to Azure Blob Storage
Set the URI to the name of your container and the name of the blob. Additionally, set the following properties to authenticate:
- AzureAccount: Set this to the account associated with the Azure blob.
- AzureAccessKey: Set this to the access key associated with the Azure blob.
URI=azureblob://mycontainer/myblob/; AzureAccount=myAccount; AzureAccessKey=myKey;
Connect to Azure Data Lake Store Gen 2
Set the URI to the name of the file system, the name of the folder which contacts your Excel files, and the name of an Excel file. Additionally, set the following properties to authenticate:
- AzureAccount: Set this to the account associated with the Azure data lake store.
- AzureAccessKey: Set this to the access key associated with the Azure data lake store.
URI=abfs://myfilesystem/folder1/file.xlsx; AzureAccount=myAccount; AzureAccessKey=myKey;
URI=abfss://myfilesystem/folder1/file.xlsx; AzureAccount=myAccount; AzureAccessKey=myKey;
Connecting to Box
Set the URI to the path to a Excel file. To authenticate to Box, use the OAuth authentication standard. See Connecting to Box for an authentication guide.
For example:
URI=box://folder1/file.xlsx; InitiateOAuth=GETANDREFRESH; OAuthClientId=oauthclientid1; OAuthClientSecret=oauthcliensecret1; CallbackUrl=http://localhost:12345;
Connecting to Dropbox
Set the URI to the path to a Excel file. To authenticate to Dropbox, use the OAuth authentication standard.
See Connecting to Dropbox for an authentication guide. You can authenticate with a user account or a service account. In the user account flow, you do not need to set any connection properties for your user credentials, as shown in the connection string below:
URI=dropbox://folder1/file.xlsx; InitiateOAuth=GETANDREFRESH; OAuthClientId=oauthclientid1; OAuthClientSecret=oauthcliensecret1; CallbackUrl=http://localhost:12345;
Connecting to SharePoint Online SOAP
Set the URI to a document library containing Excel files. To authenticate, set User and Password and SharepointUrl.
For example:
URI=sp://Documents/folder1; User=user1; Password=password1; SharepointUrl=https://subdomain.sharepoint.com;
Connecting to SharePoint Online REST
Set the URI to a document library containing Excel files. SharepointUrl is optional. If not provided, the driver will work with the root drive. To authenticate, use the OAuth authentication standard.
For example:
URI=sp://Documents/folder1; InitiateOAuth=GETANDREFRESH; SharepointUrl=https://subdomain.sharepoint.com;
Connecting to FTP
Set the URI to the address of the server followed by the path to the Excel file. To authenticate, set User and Password.
For example:
URI=ftps://localhost:990/folder1/file.xlsx; User=user1; Password=password1;
Connecting to Google Cloud Storage
Set the URI to the path to the name of the file system, the name of the folder which contains your Excel files, and the name of a Excel file. To authenticate to Google APIs, provide a ProjectId.For example:
URI=gs://bucket/remotePath/; ProjectId=PROJECT_ID;