Tablib sql export support

[takhogan]

Hi this change is to skip converting datetimes to string when the export type is sql. Have left below dataset property unchanged incase there are people who directly reference it.

@Property
def dataset(self):
"""A Tablib Dataset containing the row."""
data = tablib.Dataset()
data.headers = self.keys()

    row = _reduce_datetimes(self.values())
    data.append(row)

    return data

Related to PR:
jazzband/tablib#619

Without the update datetimes are converted as strings:

rows.export('sql')
INSERT INTO active_users (username,active,name,user_email,timezone) VALUES ('model-t', TRUE, 'Henry Ford', '[email protected]', '2016-02-06 22:28:23.894202');

With the update datetimes are converted properly as timestamps
>>> rows.export('sql')
INSERT INTO active_users (username,active,name,user_email,timezone) VALUES ('model-t', TRUE, 'Henry Ford', '[email protected]', TIMESTAMP '2016-02-06 22:28:23.894202');

Summary by CodeRabbit

• New Features

  • Improved SQL export functionality to better preserve original data types, including datetimes and booleans, when exporting query results as SQL insert statements.

• Documentation

  • Updated documentation to include an example demonstrating how to export query results as SQL insert statements, showcasing the exact output format.

[coderabbitai]

Walkthrough

The changes update documentation files to include examples of exporting query results as SQL insert statements. Additionally, the code introduces a _typed_dataset property and modifies the export logic in the Record and RecordCollection classes to preserve original data types when exporting to SQL format, while other formats continue using string representations.

Changes

Files	Change Summary
README.md, README.rst	Added documentation examples showing how to export query results as SQL insert statements using the rows.export('sql') method.
records.py	Added _typed_dataset property to Record and RecordCollection to preserve data types; updated export methods to use this for SQL export and maintain previous behavior for other formats. Removed the old export method from RecordCollection.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Record/RecordCollection
    participant Tablib

    User->>Record/RecordCollection: export(format='sql')
    alt format is 'sql'
        Record/RecordCollection->>Tablib: export(_typed_dataset, 'sql')
    else other formats
        Record/RecordCollection->>Tablib: export(dataset, format)
    end
    Tablib-->>User: Exported data in requested format

Loading

Poem

In the warren, code hops anew,
SQL exports join the view!
Typed datasets keep data right,
No datetime strings in sight.
Docs now show this bunny feat—
Exporting rows is oh-so neat!
🐇✨

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

---

Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 5941ab2 and 3ba1d44.

📒 Files selected for processing (3)

• README.md (1 hunks)
• README.rst (1 hunks)
• records.py (2 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

README.md

136-136: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)

🔇 Additional comments (6)

README.rst (1)

138-144: Documentation accurately demonstrates the new SQL export feature.

The addition of the SQL export example correctly showcases how datetime values are properly formatted as SQL timestamps in the exported SQL statements, which aligns with the PR objective.

README.md (1)

136-141: Documentation accurately demonstrates the new SQL export feature.

The addition of the SQL export example correctly showcases how datetime values are properly formatted as SQL timestamps in the exported SQL statements, which is consistent with the README.rst changes and aligns with the PR objective.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

136-136: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)

records.py (4)

102-109: Well-implemented property for preserving original data types.

This new _typed_dataset property correctly creates a dataset without converting datetime objects to strings, which is essential for proper SQL export formatting.

---

112-114: Good conditional handling for SQL export format.

The export method now correctly routes SQL format exports to use the _typed_dataset property while maintaining backward compatibility for other formats.

---

201-220: Well-implemented property for RecordCollection class.

This implementation mirrors the one in the Record class but applies it to collections of records, ensuring consistent behavior throughout the library.

---

221-226: Good implementation of export method for RecordCollection.

The export method correctly implements the same conditional logic as the Record class export method, maintaining consistency between the two classes and ensuring SQL exports preserve original data types.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.