Docs update: sql_database backend_kwargs function configuration for pyarrow backend
Description
The current documentation for the sql_database function does not adequately cover the required configuration fields, specifically the tz field, which is necessary when using the pyarrow backend.
Slack:
Steps to Reproduce
Use the sql_database function with the pyarrow backend.
Observe the ConfigFieldMissingException due to the missing tz field.
Expected Behavior
The documentation should clearly state that the tz field is required when using the pyarrow backend and provide examples of how to include it in the backend_kwargs.
Proposed Solution
To resolve this issue, the documentation should be updated to include the following:
Required Configuration Fields
Mention that the tz field is required when using the pyarrow backend.
Example Usage
Provide an example of how to include the tz field in the backend_kwargs, such as:
sql_database(..., backend_kwargs={"tz": "UTC"})
Supported Values for tz
List examples of supported time zone strings, such as:
Update the documentation to reflect the necessary configuration for the pyarrow backend, ensuring that users are aware of the required tz field and how to properly configure it.
Docs update:
sql_databasebackend_kwargs function configuration for pyarrow backendDescription
The current documentation for the
sql_databasefunction does not adequately cover the required configuration fields, specifically thetzfield, which is necessary when using the pyarrow backend.Slack:
Steps to Reproduce
sql_databasefunction with the pyarrow backend.ConfigFieldMissingExceptiondue to the missingtzfield.Expected Behavior
The documentation should clearly state that the
tzfield is required when using the pyarrow backend and provide examples of how to include it in the backend_kwargs.Proposed Solution
To resolve this issue, the documentation should be updated to include the following: Required Configuration Fields Mention that the
tzfield is required when using the pyarrow backend.Example Usage
Provide an example of how to include the tz field in the backend_kwargs, such as:
Supported Values for tz
List examples of supported time zone strings, such as:
Related Discussion
This issue was discussed in the following thread: Link to the discussion thread.
Todo
Update the documentation to reflect the necessary configuration for the pyarrow backend, ensuring that users are aware of the required tz field and how to properly configure it.