JDBC Driver for Microsoft Excel

Build 25.0.9434

URI

A Uniform Resource Identifier (URI) to a resource location containing Excel workbook file(s).

Data Type

string

Default Value

""

Remarks

This connection property, alongside IncludeSubdirectories, specifies the selected workbook(s): the pool of workbook(s) whose spreadsheets the driver models as tables. The AggregateFiles connection property only operates on the workbook(s) in this pool (others are ignored).

If this connection property is set to the path of an individual workbook file, only the sheets from that workbook are listed as tables.

If this connection property is set to a folder path, sheets from all spreadsheets in that immediate folder, as well as nested folders (if IncludeSubdirectories is set to True) are listed as tables. The DirectoryRetrievalDepth connection property operates relative to this folder.

Example Connection Strings and Queries

Below are example connection strings to Excel files or streams.

Service provider URI formats Connection example
Local localPath

file://localPath/file.xlsx

URI=C:/folder1/file.xlsx
HTTP or HTTPS http://remoteStream

https://remoteStream

URI=http://www.host1.com/streamname1;
Amazon S3 s3://bucket1/folder1/file.xlsx URI=s3://bucket1/folder1/file.xlsx; AWSAccessKey=token1; AWSSecretKey=secret1; AWSRegion=OHIO;
Google Drive gdrive://remotePath/file.xlsx URI=gdrive://folder1/file.xlsx;InitiateOAuth=GETANDREFRESH;
Box box://remotePath/file.xlsx URI=box://folder1/file.xlsx; InitiateOAuth=GETANDREFRESH; OAuthClientId=oauthclientid1; OAuthClientSecret=oauthcliensecret1; CallbackUrl=http://localhost:12345;
FTP or FTPS ftp://server:port/remotePath/file.xlsx

ftps://server:port/remotepath/file.xlsx

URI=ftps://localhost:990/folder1/file.xlsx; User=user1; Password=password1;
SFTP sftp://server:port/remotePath/file.xlsx URI=sftp://127.0.0.1:22/remotePath/file.xlsx; User=user1; Password=password1;
Sharepoint sp://https://server/remotePath/file.xlsx URI=sp://https://domain.sharepoint.com/Documents/file.xlsx; User=user1; Password=password1;

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434