Skip to content

Conversation

MiguelElGallo
Copy link
Owner

This pull request updates the README.md file to provide more detailed instructions for setting up and using the MPZSQL server, particularly in DuckLake mode. The changes include new sections for configuration, warnings, and usage, as well as improved formatting and additional resources.

Documentation Enhancements:

  • Added a new "Warning" section to emphasize the experimental state of the software and caution against production use.
  • Expanded the "Minimum Configuration for Starting in DuckLake Mode" section with detailed steps for Azure login, required permissions, and running the server.
  • Included instructions for testing the server with a JDBC client and a note about Logfire integration for logging.

Formatting and Structural Improvements:

  • Reorganized sections for clarity, including renaming and updating the "Starting the Server" section.
  • Removed redundant and outdated instructions to avoid duplication and confusion.

These updates aim to make the documentation more user-friendly and comprehensive for developers setting up MPZSQL.

@Copilot Copilot AI review requested due to automatic review settings July 21, 2025 18:10
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request significantly enhances the README.md documentation for MPZSQL by improving organization, adding critical warnings, and providing more comprehensive setup instructions. The changes focus on making the documentation more user-friendly and comprehensive for developers setting up the Apache Arrow FlightSQL server in DuckLake mode.

  • Reorganized content with better section hierarchy and moved key setup instructions to the top
  • Added prominent warning about experimental status and production usage restrictions
  • Enhanced setup instructions with detailed Azure authentication requirements and client testing guidance


## Warning!

This software is in experimental state. I have not tested the security features yet. The software it uses like [DuckLake](https://github.com/duckdb/ducklake) is also in experimental state. (As of July 2025)
Copy link

Copilot AI Jul 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Grammar error: 'experimental state' should be 'an experimental state'.

Suggested change
This software is in experimental state. I have not tested the security features yet. The software it uses like [DuckLake](https://github.com/duckdb/ducklake) is also in experimental state. (As of July 2025)
This software is in an experimental state. I have not tested the security features yet. The software it uses like [DuckLake](https://github.com/duckdb/ducklake) is also in an experimental state. (As of July 2025)

Copilot uses AI. Check for mistakes.

## Starting the Server

Check the with:
Check the help with:
Copy link

Copilot AI Jul 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Grammar error: 'Check the help with:' should be 'Check the help with:' or more naturally 'Check help with:' or 'View help with:'.

Suggested change
Check the help with:
View help with:

Copilot uses AI. Check for mistakes.

Copy link

codecov bot commented Jul 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

@MiguelElGallo MiguelElGallo merged commit 592da2d into main Jul 21, 2025
5 checks passed
@MiguelElGallo MiguelElGallo deleted the feature/documentation branch July 21, 2025 18:12
MiguelElGallo added a commit that referenced this pull request Jul 26, 2025
Update README.md to enhance clarity and organization of server setup …
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant