Identifies the workbook that is used as the source of metadata when aggregating sheets with the AggregateFiles connection property.

Data Type

string

Default Value

""

Remarks

When the AggregateFiles connection property is enabled, the driver aggregates the content of identically-named sheets from multiple workbook files into consolidated tables called aggregate sheet tables.

To facilitate aggregation of identically-named sheets, a metadata source workbook must be selected. The driver models each sheet from this workbook as an aggregate sheet table named after that sheet.

You can use this connection property to explicitly designate a workbook file as the metadata source workbook. If this connection property is not set, the first workbook file in the directory is used as the metadata source workbook.

The path that you specify for the metadata source workbook is resolved as follows:

• Relative path: resolved relative to the directory of the connection URI (the folder being aggregated).
• Absolute local path: a local path that starts with /, \, or a drive letter followed by a separator (for example, C:\ or C:/), optionally prefixed with file://, is always allowed, even when the connection points to cloud storage. In this case, the driver reads the metadata source workbook from the local file system while the sheet data is read from the configured storage. Drive-relative values such as C: or C:dev are not treated as absolute paths.
• Absolute URI with a scheme: an absolute URI that includes a scheme (for example, s3://, gs://, or azureblob://) must point to the same storage as the connection. If its scheme does not match the connection's storage type, the connection fails with a configuration error.