Merge pull request #13 from microsoft/alphaChanges

Alpha changes

Author: sumitmsft

README.md

@@ -2,7 +2,7 @@
 
 **mssql-python** is a Python driver for Microsoft SQL Server and the Azure SQL family of databases. It leverages Direct Database Connectivity (DDBC) that enables direct connections to SQL Server without requiring an external driver manager. Designed to comply with the [DB API 2.0](https://peps.python.org/pep-0249/) specification, this driver also introduces Pythonic enhancements for improved usability and functionality. It supports a full range of database operations, including connection management, query execution, and transaction handling.
 
-[Documentation](https://github.com/microsoft/mssql-python/wiki) | [Release Notes](https://github.com/microsoft/mssql-python/releases)
+[Documentation](https://github.com/microsoft/mssql-python/wiki) | [Release Notes](https://github.com/microsoft/mssql-python/releases) | [Roadmap](https://github.com/microsoft/mssql-python/roadmap)
 
 ## Installation
 

ROADMAP.md

@@ -0,0 +1,64 @@
+# Roadmap for Python Driver for SQL Server
+
+We are thrilled to introduce our upcoming Python driver for SQL Server – a modern, high performant, and developer-friendly SDK designed to enhance your SQL Server database connectivity experience. This roadmap outlines the key structural improvements, new features and upcoming enhancements that will set our driver apart from existing solutions.
+
+Why a New Driver?
+
+Unlike existing Python SQL Server drivers, we are making substantial improvements to performance, maintainability, and usability by re-architecting the core internals. Our focus is on seamless integration between Python and C++, efficient memory management, better state handling, and advanced DBAPI enhancements.
+
+Here’s what’s coming:
+
+
+**1. Structural changes for abstraction of C++ and Python codebase**
+
+We are undertaking significant structural changes to provide a clear abstraction between C++ code and Python. This will ensure better maintainability, improved performance, and a cleaner codebase. By leveraging existing pybind11 module, we aim to create a seamless integration between the two languages, allowing for efficient execution and easier debugging.
+
+This will improve:
+- Maintainability via simplified modular architecture
+- Performance via optimized C++ code
+- Debugging, traceability and seamless interaction between C++ and Python via with PyBind11 module integration
+
+**2. Future DBAPI Enhancements**
+
+In future releases, we plan to add several DBAPI enhancements, including:
+- `Callproc()` : Support for calling stored procedures.   
+- `setinputsize()` and `setoutputsize()`
+- `Output` and `InputOutput` Parameters: Handling of output and input-output parameters in stored procedures.
+- Optional DBAPIs: Additional optional DBAPI features to provide more flexibility and functionality for developers.
+
+**3. Connection Pooling**
+
+Connection pooling will be made available soon, allowing for efficient reuse of database connections. This feature will significantly improve performance by reducing the overhead associated with establishing new connections for each database operation .
+- Reduce Connection creation overhead
+- Improve scalability via efficient reuse of connections
+- Enhance multi-threaded operation performance
+
+**4. Cross-Platform Support: MacOS and Linux Distributions** 
+
+We are committed to providing cross-platform support for our Python driver. In the next few months, we will release versions compatible with MacOS and various Linux distributions. This will enable developers to use the driver on their preferred operating systems without any compatibility issues. 
+Soon, you will be able to:
+- Use the driver across multiple environments and OS
+- Deploy application on cloud-native platforms
+- Avoid compatibility issues with system-dependent code
+- Flexibility in choosing development environments
+
+**5. Asynchronous Query Execution**
+
+We are also working on adding support for asynchronous query execution. This feature will allow developers to execute queries without blocking the main thread, enabling more responsive and efficient applications. Asynchronous query execution will be particularly beneficial for applications that require high concurrency and low latency  .
+- No blocking of the main thread
+- Faster parallel processing – ideal for high-concurrency applications
+- Better integration with async frameworks like asyncio
+
+
+We are dedicated to continuously improving the Python driver for SQL Server and welcome feedback from the community. Stay tuned for updates and new features as we work towards delivering a high-quality driver that meets your needs.
+Join the Conversation!
+
+We are building this for developers, with developers. Your feedback will shape the future of the driver.
+- Follow our [Github Repo](https://github.com/microsoft/mssql-python)>
+- Join Discussions – Share your ideas and suggestions
+- Try our alpha release – Help us refine and optimize the experience
+
+Stay tuned for more updates, and lets build something amazing together. Watch this space for announcements and release timelines.
+
+
+