Specifies when the provider retrieves column metadata for tables in the REST schema. Metadata can be loaded at startup or on first use.

Possible Values

OnUse, OnStart

Data Type

string

Default Value

"OnUse"

Remarks

The GetColumnsMetadata property controls when the provider retrieves and caches column metadata for tables when using the REST schema. This affects how quickly queries can begin and how much upfront loading occurs. The available options include:

• OnStart — The driver retrieves and caches metadata for all columns in every table before executing the first statement. This can reduce delays during queries, but may increase initial connection time.
• OnUse — The driver retrieves and caches metadata for each table the first time it is queried, reducing startup time but potentially introducing a delay when the table is first accessed.

This property is useful for balancing faster connection times against the need for immediate query responsiveness across multiple tables.

Performance Considerations

Retrieving metadata on start can reduce query latency later by pre-loading all column definitions, but may significantly increase connection time, especially for large datasets. Retrieving metadata on use allows faster connections, but may delay the first query to each table as metadata is loaded on demand.