Cline

# Component Design Standards for DuckDB This document outlines the component design standards for DuckDB, focusing on creating reusable, maintainable, and performant components within the DuckDB ecosystem. These standards aim to ensure code quality, consistency, and long-term maintainability across the DuckDB codebase. ## 1. Core Principles of Component Design in DuckDB DuckDB, being an embedded analytical database, benefits greatly from well-designed components. Components should be modular, loosely coupled, and highly cohesive. These principles increase reusability, testability, and ease of maintenance. * **Modularity:** Each component should have a clear, well-defined purpose. * **Loose Coupling:** Components should minimize dependencies on other components. This reduces the impact of changes and makes components more independent. * **High Cohesion:** All elements within a component should be closely related and work together towards a single, well-defined purpose. * **Abstraction:** Hide implementation details and expose only necessary interfaces. This allows for internal changes without affecting external users of the component. * **Single Responsibility Principle (SRP):** Each component should have only one reason to change. ## 2. Component Granularity and Scope ### 2.1 Defining Component Boundaries * **Do This:** Define clear boundaries for each component based on logical functionality. For example, a component might be responsible for parsing SQL, optimizing queries, or executing specific operator types. * **Don't Do This:** Create components that are too large and encompass multiple unrelated functionalities, or too small, leading to excessive fragmentation and overhead. * **Why:** Well-defined boundaries help maintainability and make it easier to understand and reason about the system. ### 2.2 Examples of DuckDB Components Examples of concrete components within DuckDB's architecture include: * **Parser:** Responsible for parsing SQL queries into an abstract syntax tree (AST). * **Optimizer:** Responsible for transforming the AST into an optimized query plan. * **Execution Engine:** Responsible for executing the query plan. * **Storage Manager:** Manages data storage and retrieval. * **Vector Operations (e.g., "src/common/vector_operations"):** Implements vectorized operations for efficient data processing. * **Scalar Functions (e.g., "src/function/scalar"):** Houses implementations of SQL scalar functions. ### 2.3 Standard: Component naming and file structure * **Do This:** Use descriptive names for components and organize files logically within the "src" directory. Follow the existing DuckDB directory structure which typically separates components by related functionalities. For example, functions are grouped under "src/function", optimizers under "src/optimizer", etc. * **Don't Do This:** Use generic or ambiguous names that don't clearly indicate the component's purpose. Scatter code across unrelated directories. * **Why:** A clear and consistent file structure improves code discoverability and maintainability. Predictable naming makes it easier to navigate the codebase. **Example:** A new aggregate function related to windowing might be placed in "src/function/aggregate/distributive". The function's implementation would be in a file named "my_new_window_agg_function.cpp" or similar. ## 3. Interfaces and Abstraction ### 3.1 Defining Component Interfaces * **Do This:** Define clear and concise interfaces for each component. Use abstract classes or interfaces in C++ to define the contracts that components must adhere to. * **Don't Do This:** Expose internal implementation details in the interface. This can lead to tight coupling and make it difficult to change the internal implementation without breaking other components. * **Why:** Well-defined interfaces promote loose coupling and allow for easier testing and mocking. **Example (Abstract Class):** """c++ // src/optimizer/rule.h class Rule { public: virtual ~Rule() = default; virtual std::unique_ptr<LogicalOperator> Apply(std::unique_ptr<LogicalOperator> op, Optimizer &optimizer) = 0; virtual bool CanApply(const std::unique_ptr<LogicalOperator> &op) = 0; }; """ ### 3.2 Abstraction Levels * **Do This:** Consider different levels of abstraction. Provide high-level interfaces for common use cases and lower-level interfaces for more advanced scenarios. This aligns with the principle of "progressive disclosure," where complexity is hidden until needed. * **Don't Do This:** Expose only low-level interfaces, forcing users to deal with unnecessary complexity. Conversely, don't hide too much information, preventing access to needed customization. * **Why:** Flexible abstraction levels cater to diverse use cases and skill levels. ### 3.3 Standard: Using Abstract Factories * **Do This:** Use abstract factories to decouple the creation of objects from their usage. This allows you to switch between different implementations of a component without modifying the code that uses it. * **Don't Do This:** Directly instantiate concrete classes throughout the codebase, creating tight dependencies on specific implementations. * **Why:** Abstract factories enhance flexibility and testability. **Example:** The creation of different physical operators (e.g., Hash Join, Nested Loop Join) could be handled by an abstract factory. ## 4. Error Handling and Logging ### 4.1 Robust Error Handling * **Do This:** Implement robust error handling within each component. Use exceptions or error codes to signal failures and provide informative error messages. DuckDB uses exceptions extensively for error handling. * **Don't Do This:** Ignore errors or propagate them silently. This can lead to unpredictable behavior and make it difficult to debug issues. * **Why:** Proper error handling is crucial for reliability and maintainability. **Example:** """c++ #include "duckdb.hpp" #include "iostream" using namespace duckdb; void MyComponent::MyFunction(int input) { if (input < 0) { throw InvalidInputException("Input must be non-negative"); } // ... perform operations } int main() { DuckDB db(":memory:"); Connection con(db); try { con.Query("SELECT MyFunction(-1)"); } catch (InvalidInputException &e) { std::cerr << "Error: " << e.what() << std::endl; } return 0; } """ ### 4.2 Logging * **Do This:** Use DuckDB's logging mechanisms to log important events, warnings, and errors. Configure logging levels appropriately to control the verbosity of the output. Consider integration with the DuckDB telemetry system. * **Don't Do This:** Use "std::cout" or "printf" for logging. These methods are not controllable and cannot be easily disabled in production environments. * **Why:** Logging provides valuable insights into the behavior of the system and helps diagnose issues. Using a consistent logging framework allows for centralized management and analysis of logs. **Note:** DuckDB has a sophisticated logging mechanism, but exact usage details are not readily available in the public documentation. Refer to internal DuckDB documentation and existing code for specific logging patterns. ## 5. Testing ### 5.1 Unit Testing * **Do This:** Write unit tests for each component to verify its functionality and robustness. Use a testing framework to automate the execution of tests and ensure consistent results. * **Don't Do This:** Neglect unit testing. Untested code is more likely to contain bugs and be difficult to maintain. * **Why:** Unit tests provide confidence in the correctness of the code and help prevent regressions. DuckDB uses a custom testing framework. Refer to the existing tests in the "test" directory for examples of how to write unit tests for DuckDB components. ### 5.2 Integration Testing * **Do This:** Write integration tests to verify the interaction between different components. This ensures that the components work together correctly. DuckDB's SQL-based testing framework is well-suited for this. * **Don't Do This:** Assume that components will work together correctly without integration testing. * **Why:** Integration tests catch issues that may not be apparent from unit tests alone. **Example:** Test a query involving the Parser, Optimizer, and Execution Engine components. ## 6. Concurrency and Thread Safety ### 6.1 Thread Safety * **Do This:** Design components to be thread-safe, especially if they are accessed from multiple threads concurrently. Use appropriate synchronization mechanisms (e.g., mutexes, atomic operations) to protect shared data. DuckDB's internal concurrency model often relies on immutable data structures and vectorized operations to minimize lock contention. * **Don't Do This:** Assume that components are thread-safe without proper verification. Data races and other concurrency issues can lead to unpredictable behavior. * **Why:** Thread safety is crucial for performance and stability in a multi-threaded environment. ### 6.2 Data Structures * **Do This:** When possible, prioritize using concurrent data structures that inherently handle thread safety, or design your code to avoid shared mutable state altogether using techniques like message passing. DuckDB makes extensive use of vectorized operations, which often allows for lock-free concurrency. * **Don't Do This:** Use simple data structures without considering thread safety and rely entirely on locks. * **Why:** Concurrent data structures often offer better performance and scalability compared to using simple data structures with locks. Avoiding mutable shared state is the ideal (though often impractical) approach. ## 7. Code Style and Formatting ### 7.1 Consistent Style * **Do This:** Follow a consistent code style throughout the codebase. Use a code formatter (e.g., clang-format) to automatically enforce the style guidelines. Refer to the DuckDB's existing code for style conventions. * **Don't Do This:** Use inconsistent code styles. This can make the code harder to read and understand. * **Why:** A consistent code style improves readability and maintainability. ### 7.2 Naming Conventions * **Do This:** Follow consistent naming conventions for variables, functions, classes, and other identifiers. Use descriptive names that clearly indicate the purpose of the identifier. Prefer longer, descriptive names over short, cryptic ones. * **Don't Do This:** Use inconsistent or ambiguous naming conventions. * **Why:** Clear naming conventions improve code readability and maintainability. ## 8. Performance Considerations ### 8.1 Vectorized Operations * **Do This:** Leverage DuckDB's vectorized execution engine to perform operations on large batches of data efficiently. Use the "Vector" class and its associated methods for vectorized operations. Understanding and using vectorized operations is paramount to building performant DuckDB components. * **Don't Do This:** Implement operations on individual data elements. This can lead to significant performance overhead. * **Why:** Vectorized operations maximize CPU utilization and minimize data transfer overhead. **Example:** """c++ #include "duckdb.hpp" using namespace duckdb; void MyComponent::Add(Vector &left, Vector &right, Vector &result, idx_t count) { auto left_data = FlatVector::GetData<int32_t>(left); auto right_data = FlatVector::GetData<int32_t>(right); auto result_data = FlatVector::GetData<int32_t>(result); for (idx_t i = 0; i < count; i++) { result_data[i] = left_data[i] + right_data[i]; } } """ ### 8.2 Data Locality * **Do This:** Design components to maximize data locality. This means keeping related data close together in memory to reduce cache misses and improve performance. DuckDB's columnar storage format enhances data locality for analytical workloads. * **Don't Do This:** Scatter related data across different memory locations. * **Why:** Data locality is crucial for performance. Accessing data from memory is much faster than accessing data from disk. ### 8.3 Minimize Memory Allocation * **Do This:** Minimize memory allocation and deallocation within performance-critical sections of code. Use memory pools or other techniques to reuse memory. DuckDB has its own memory management mechanisms; familiarize yourself with them. * **Don't Do This:** Allocate and deallocate memory frequently. * **Why:** Memory allocation and deallocation can be expensive operations, especially in high-performance systems. ## 9. Security Considerations ### 9.1 Input Validation * **Do This:** Validate all inputs to components to prevent security vulnerabilities such as SQL injection and buffer overflows. Use parameterized queries to prevent SQL injection. * **Don't Do This:** Trust inputs without proper validation. * **Why:** Input validation is crucial for security. Malicious inputs can be used to compromise the system. ### 9.2 Data Encryption * **Do This:** Consider encrypting sensitive data at rest and in transit. Use strong encryption algorithms and follow security best practices. DuckDB supports encryption extensions; use them where appropriate. * **Don't Do This:** Store sensitive data in plain text. * **Why:** Data encryption protects sensitive data from unauthorized access. ## 10. Future-Proofing * **Do This:** Follow design principles that accommodate and anticipate future changes in DuckDB. Consider the potential implications of adding new data types, storage formats, or query optimization techniques. * **Don't Do This:** Create components that are tightly coupled to specific implementation details or that make assumptions about the current state of the system. * **Why:** Designed-for-change architecture ensures that future updates or new features will not break components as easily as a more brittle design. By following these component design standards, DuckDB developers can create a robust, maintainable, and performant codebase. This will contribute to the long-term success of the DuckDB project.

# Performance Optimization Standards for DuckDB This document outlines the performance optimization standards for DuckDB, providing guidelines for developers to write efficient and performant code. These standards are tailored for DuckDB's architecture and are designed to improve application speed, responsiveness, and resource usage. ## 1. Query Optimization ### 1.1. Understanding Query Plans **Standard:** Analyze query plans to identify bottlenecks and optimize query execution. * **Do This:** Use "EXPLAIN" to examine the query plan and identify areas for improvement. * **Don't Do This:** Blindly execute queries without understanding their underlying execution strategy. **Why:** Understanding the query plan allows developers to make informed decisions about indexing, data types, and query structure. **Example:** """sql EXPLAIN SELECT * FROM lineitem WHERE l_orderkey = 12345; """ This will output the query plan, showing the steps DuckDB will take to execute the query. Areas of concern include full table scans, inefficient joins, or suboptimal sorting. ### 1.2. Indexing Strategies **Standard:** Employ appropriate indexing strategies to accelerate data retrieval. * **Do This:** Create indexes on frequently queried columns, especially those used in "WHERE" clauses and join conditions. Consider using multi-column indexes for composite queries. * **Don't Do This:** Over-index tables, as this can slow down write operations and increase storage overhead. Avoid indexing columns with low cardinality or those rarely used in queries. **Why:** Indexes significantly reduce the amount of data that needs to be scanned, resulting in faster query execution. **Example:** """sql -- Single-column index CREATE INDEX idx_orderkey ON lineitem (l_orderkey); -- Multi-column index CREATE INDEX idx_order_ship ON lineitem (l_orderkey, l_shipdate); """ Carefully consider the order of columns in multi-column indexes. The most frequently queried column should come first. DuckDB (as of recent versions) also supports expression indexes, though these should be used judiciously as they can complicate maintenance. ### 1.3. Data Type Considerations **Standard:** Use the most appropriate data types for your data to minimize storage and improve performance. * **Do This:** Use smaller integer types (e.g., "SMALLINT", "INTEGER") if the range of values allows. Use "VARCHAR" with length limits when appropriate instead of "TEXT" for string data. Use the "DATE" and "TIMESTAMP" types for date and time data, respectively. * **Don't Do This:** Use unnecessarily large data types, such as "BIGINT" when "INTEGER" suffices. Use "TEXT" for columns that contain short, fixed-length strings. **Why:** Smaller data types reduce storage space and memory usage, leading to faster data processing. **Example:** """sql -- Good: Using SMALLINT when appropriate CREATE TABLE orders ( order_id SMALLINT, -- Assuming order IDs won't exceed the range of SMALLINT order_date DATE ); -- Bad: Using BIGINT unnecessarily CREATE TABLE products ( product_id BIGINT, -- INTEGER might be sufficient product_name VARCHAR -- Length limit missing ); -- Better: Using VARCHAR with length limit and explicit timestamp CREATE TABLE products ( product_id INTEGER, product_name VARCHAR(255), created_at TIMESTAMP ); """ ### 1.4. Join Optimization **Standard:** Optimize join operations to minimize the amount of data processed. * **Do This:** Use appropriate join algorithms (DuckDB generally auto-selects based on table sizes and statistics). Ensure join columns are indexed. If applicable, use "HASH JOIN" for equality joins on larger tables. Use "BROADCAST JOIN" when joining a large table to a considerably small table (DuckDB often optimizes automatically but understanding the strategy is important). Leverage pre-calculated aggregates if appropriate. * **Don't Do This:** Perform joins without indexes on join columns. Join on complex expressions rather than simple column lookups. Perform cartesian products by omitting join conditions. **Why:** Efficient join operations are critical for query performance, especially in data warehousing scenarios. **Example:** """sql -- Good: Indexed join columns CREATE INDEX idx_customer_id ON orders (customer_id); CREATE INDEX idx_customer_id ON customers (customer_id); SELECT * FROM orders JOIN customers ON orders.customer_id = customers.customer_id; -- Consider broadcasting small tables: (DuckDB might do this automatically though) SELECT /*+ BROADCAST(customers) */ * FROM orders JOIN customers ON orders.customer_id = customers.customer_id; -- Bad: No indexes, forcing a full table scan SELECT * FROM orders JOIN customers ON orders.customer_id = customers.customer_id; -- Assuming no index on customer_id """ ### 1.5. Subquery Optimization **Standard:** Rewrite subqueries where possible to improve performance. * **Do This:** Use "JOIN" operations instead of correlated subqueries when possible. Use Common Table Expressions (CTEs) to break down complex queries into smaller, manageable parts. * **Don't Do This:** Use correlated subqueries excessively, as they can significantly slow down query execution. **Why:** Correlated subqueries can be inefficient because they are executed for each row in the outer query. **Example:** """sql -- Bad: Correlated subquery SELECT o.order_id FROM orders o WHERE EXISTS ( SELECT 1 FROM lineitem l WHERE l.order_id = o.order_id ); -- Good: Using a JOIN instead SELECT DISTINCT o.order_id FROM orders o JOIN lineitem l ON o.order_id = l.order_id; -- Good: Using a CTE for readability and potential optimization WITH OrderItems AS ( SELECT order_id FROM lineitem ) SELECT o.order_id FROM orders o WHERE o.order_id IN (SELECT order_id FROM OrderItems); """ ### 1.6. Filtering Early **Standard:** Apply filters as early as possible in the query execution pipeline. * **Do This:** Place "WHERE" clauses that significantly reduce the number of rows processed at the beginning of the query. * **Don't Do This:** Filter data late in the query execution pipeline, after expensive operations like joins or aggregations. **Why:** Filtering early reduces the amount of data that subsequent operations need to process. **Example:** """sql -- Good: Filtering early significantly reduces rows SELECT * FROM orders WHERE order_date > '2023-01-01' AND customer_id IN (SELECT customer_id FROM active_customers); -- Bad: Filtering late after a join (less efficient if only a fraction of orders are recent) SELECT * FROM orders JOIN customers ON orders.customer_id = customers.customer_id WHERE order_date > '2023-01-01'; """ ## 2. Data Loading and Storage ### 2.1. Bulk Loading **Standard:** Use bulk loading techniques for large datasets. * **Do This:** Use "COPY" command or DuckDB's API to load data in bulk. Use vectorized reads when possible. * **Don't Do This:** Load data row-by-row using individual "INSERT" statements. **Why:** Bulk loading is significantly faster than individual "INSERT" statements. **Example:** """sql -- CSV import COPY lineitem FROM 'lineitem.tbl' (DELIMITER '|'); -- Parquet import (highly recommended due to DuckDB's columnar nature) COPY lineitem FROM 'lineitem.parquet' (FORMAT 'PARQUET'); """ Ensure the data is pre-sorted by clustering key for even greater performance, especially when creating clustered indexes. ### 2.2. Data Clustering and Sorting **Standard:** Cluster and sort data based on common query patterns. * **Do This:** Use "ALTER TABLE ... CLUSTER BY" to physically sort the data on disk based on specific columns. This is extremely beneficial for range queries. * **Don't Do This:** Neglect to cluster data, especially for large tables. Cluster by columns that are rarely used in queries. **Why:** Clustering data improves query performance by reducing the amount of data that needs to be scanned for range queries or queries involving a specific order. **Example:** """sql ALTER TABLE lineitem CLUSTER BY l_orderkey, l_shipdate; --Cluster by orderkey, then by shipdate within each orderkey """ ### 2.3. Compression **Standard:** Enable compression for large datasets to reduce storage space and improve I/O performance. * **Do This:** Use compression algorithms like Zstd or Snappy, especially when storing data in Parquet format. DuckDB automatically handles compression for its internal storage. * **Don't Do This:** Store uncompressed data unnecessarily. **Why:** Compression reduces the amount of data that needs to be read from disk, leading to faster query execution. **Example:** """sql -- Parquet with Zstd compression (best generally for both compression ratio and speed) COPY lineitem TO 'lineitem_compressed.parquet' (FORMAT 'PARQUET', COMPRESSION 'ZSTD'); -- Explicit compression -- DuckDB auto-compression (will use a reasonable default) CREATE TABLE compressed_table AS SELECT * FROM lineitem; """ ### 2.4. Partitioning (using Parquet Files) **Standard:** Partition data into separate files based on logical criteria (e.g., date ranges, geographic regions). * **Do This:** Store data in Parquet files, partitioned by relevant columns. Use DuckDB's globbing capabilities to efficiently query specific partitions. * **Don't Do This:** Store all data in a single large file, as this can slow down query execution. **Why:** Partitioning allows DuckDB to only read the relevant files for a given query, improving performance. **Example:** Assume you have Parquet files partitioned by year and month: "/data/orders/year=2023/month=01/orders.parquet", "/data/orders/year=2023/month=02/orders.parquet", etc. """sql -- Query data for a specific month SELECT * FROM read_parquet('/data/orders/year=2023/month=01/*.parquet'); -- Query data for a specific year SELECT * FROM read_parquet('/data/orders/year=2023/*.parquet'); -- Query for all data SELECT * FROM read_parquet('/data/orders/*/*.parquet'); --Use cautiously. Is this REALLY what you meant? """ ### 2.5. Vectorized Reads **Standard:** Utilize DuckDB's vectorized reads for efficient data processing from disk or other external sources. * **Do This:** When reading from Parquet or other file formats, ensure DuckDB is configured to utilize vectorized reads. This is enabled by default; however, verify configurations in case of custom setups. * **Don't Do This:** Implement custom, row-by-row processing when reading data into DuckDB, especially when standard file formats are used. **Why:** Vectorized reads allow DuckDB to process data in batches, significantly improving the throughput of data ingestion and query execution. **Example:** DuckDB automatically utilizes vectorized reads for Parquet files. You generally will not need to configure this directly. However, for custom data-loading implementations, ensure that you are reading data in batches and passing it to DuckDB's vectorized execution engine. ## 3. Concurrency and Parallelism ### 3.1. Connection Management **Standard:** Manage database connections efficiently. * **Do This:** Use connection pooling to reuse connections and avoid the overhead of creating new connections for each query. Close connections when they are no longer needed. * **Don't Do This:** Create a new connection for each query. Leave connections open indefinitely. **Why:** Establishing database connections can be expensive. Connection pooling improves performance by reusing existing connections. **Example (Python):** """python import duckdb import threading # Use a thread-local connection local = threading.local() def get_connection(): if not hasattr(local, "con"): local.con = duckdb.connect('my_database.duckdb') return local.con def run_query(query): con = get_connection() result = con.execute(query).fetchall() return result """ ### 3.2. Parallel Query Execution **Standard:** Leverage DuckDB's parallel query execution capabilities. * **Do This:** Configure the number of threads used for query execution using "PRAGMA threads". Ensure that queries are designed to benefit from parallelism (e.g., large scans, aggregations). * **Don't Do This:** Set the number of threads too high, as this can lead to excessive context switching and reduced performance. **Why:** Parallel query execution can significantly improve performance for CPU-bound operations. **Example:** """sql PRAGMA threads=8; -- Use 8 threads SELECT l_returnflag, l_linestatus, SUM(l_quantity) AS sum_qty, SUM(l_extendedprice) AS sum_base_price, SUM(l_discount) AS sum_disc_price FROM lineitem GROUP BY l_returnflag, l_linestatus; PRAGMA threads=-1; --Use all available cores """ Carefully assess the optimal number of threads for your workload. For I/O bound workloads, increasing number of threads excessively can introduce contention overhead. ## 4. Runtime Configuration ### 4.1. Memory Management **Standard:** Configure the amount of memory available to DuckDB. * **Do This:** Use "PRAGMA memory_limit" to set the memory available to DuckDB. Monitor memory usage to ensure that the limit is appropriate. * **Don't Do This:** Allow DuckDB to use excessive amounts of memory, potentially starving other processes. Set the memory limit too low, which can lead to disk spilling and reduced performance. **Why:** Proper memory management prevents out-of-memory errors and ensures efficient query execution. **Example:** """sql PRAGMA memory_limit='16GB'; -- Set memory limit to 16GB """ ### 4.2. Temporary Storage **Standard:** Ensure that temporary storage is configured correctly. * **Do This:** Use the "temp_directory" configuration option to specify a location for temporary files. Ensure that the specified location has sufficient storage space and high I/O performance. * **Don't Do This:** Allow temporary files to be written to the default location, which may be on a slower storage device. **Why:** DuckDB uses temporary storage for intermediate results. Configuring temporary storage correctly can improve query performance, especially when dealing with large datasets. **Example:** """sql PRAGMA temp_directory='/mnt/fast_ssd/duckdb_tmp'; """ ### 4.3. Detailed Monitoring **Standard:** Using tools to actively monitor performance of queries and IO operations * **Do This:** Use DuckDB's built-in performance monitoring features along with external system monitoring tools * **Don't Do This:** Neglect monitoring the impact of configuration changes and code optimization. Changes should be tested thoroughly, and can sometimes negatively impact performance for some workloads. **Why:** Consistent monitoring helps ensure that changes are having the impact you expect, and catches unexpected degradation. **Example:** While DuckDB contains some minimal internal monitoring, focus should be on wrapping the application in well-known monitoring frameworks used in the deployment envirnoment such as Prometheus, Grafana, or similar tools. ## 5. Code Maintainability and Readability ### 5.1. Code Formatting and Style **Standard:** Follow a consistent code formatting style. * **Do This:** Use a consistent indentation style (e.g., 4 spaces). Use meaningful variable and function names. Add comments to explain complex logic. * **Don't Do This:** Use inconsistent indentation. Use cryptic variable names. Write code without comments. **Why:** Consistent code formatting improves readability and maintainability. **Example:** """sql -- Good: Well-formatted SQL SELECT c.customer_id, c.customer_name, COUNT(o.order_id) AS order_count FROM customers c LEFT JOIN orders o ON c.customer_id = o.customer_id WHERE c.region = 'North America' GROUP BY c.customer_id, c.customer_name ORDER BY order_count DESC LIMIT 10; -- Bad: Poorly formatted SQL select c.customer_id,c.customer_name,count(o.order_id) from customers c left join orders o on c.customer_id=o.customer_id where c.region='North America' group by c.customer_id,c.customer_name order by count(o.order_id) desc limit 10; """ ### 5.2. Modular Design **Standard:** Break down complex queries and logic into smaller, reusable modules. * **Do This:** Use Common Table Expressions (CTEs) to break down complex queries into smaller parts. Create reusable functions for common operations. * **Don't Do This:** Write monolithic queries that are difficult to understand and maintain. **Why:** Modular design improves code organization and reduces code duplication. **Example:** """sql -- Good: Using CTEs to break down a complex query WITH CustomerOrders AS ( SELECT customer_id, COUNT(order_id) AS order_count FROM orders GROUP BY customer_id ), TopCustomers AS ( SELECT customer_id FROM CustomerOrders ORDER BY order_count DESC LIMIT 10 ) SELECT c.customer_id, c.customer_name, co.order_count FROM customers c JOIN TopCustomers tc ON c.customer_id = tc.customer_id JOIN CustomerOrders co ON c.customer_id = co.customer_id; -- Bad: Monolithic query SELECT c.customer_id, c.customer_name, COUNT(o.order_id) FROM customers c JOIN orders o ON c.customer_id = o.customer_id GROUP BY c.customer_id, c.customer_name ORDER BY COUNT(o.order_id) DESC LIMIT 10; """ By adhering to these coding standards, DuckDB developers can write efficient, maintainable, and performant code, ensuring that applications utilizing DuckDB run smoothly and effectively. The consistent application of these rules, aided by AI tools, should lead to a higher quality codebase and improved overall system performance. Remember to stay current with DuckDB's release notes, especially those regarding optimization, as the engine is rapidly evolving.

# API Integration Standards for DuckDB This document outlines the coding standards for integrating DuckDB with external APIs and backend services. It focuses on best practices to ensure maintainability, performance, and security when leveraging DuckDB in conjunction with external data sources and services. ## 1. General Principles of API Integration ### 1.1. Clear Separation of Concerns **Do This:** * Isolate API interaction logic from core database operations. * Create dedicated modules or functions responsible for communicating with external APIs. **Don't Do This:** * Embed API calls directly within SQL queries or stored procedures. This makes debugging incredibly difficult and tightly couples your SQL logic to an external service. **Why:** Separate concerns promote modularity and testability. API interactions are often subject to change (e.g., API version updates, schema changes), so isolating them reduces the impact of these changes on core database logic. **Example:** """python # Correct: Separate API interaction logic import requests import duckdb def fetch_data_from_api(api_url): """Fetches data from an external API.""" try: response = requests.get(api_url) response.raise_for_status() #

# Core Architecture Standards for DuckDB This document outlines the core architectural standards for contributing to and maintaining the DuckDB project. It focuses on the high-level structure, organization, and key design principles that guide development. Adherence to these standards ensures consistency, maintainability, performance, and security within the DuckDB codebase. ## 1. Fundamental Architectural Principles DuckDB's architecture is designed around several key principles that guide its development: * **Columnar Data Storage:** Data is stored in columns, enabling efficient analytical processing by minimizing I/O and maximizing vectorization opportunities. * **In-Process Execution:** DuckDB operates within the same process as the application, eliminating serialization/deserialization overhead and enabling tight integration. This design choice favors simplicity and speed for many common use cases. * **Vectorized Execution:** Queries are processed using vectorized execution, where operations are applied to entire columns (or chunks of columns) at once. This dramatically improves performance compared to row-by-row processing. * **Extensibility:** DuckDB is designed to be extensible. Custom functions ("UDFs"), table functions ("TDFs"), and other extensions can be added to provide specialized functionality. * **Data locality:** DuckDB tries to maintain high data locality by grouping related data together (e.g. by using radix partitioning). This improves cache hit ratios and reduces memory access latency. * **Minimal Dependencies:** Aiming for ease of deployment and portability, DuckDB strives to minimize external dependencies. * **Cost-Based Optimizer:** Utilizes a cost-based optimizer for efficient query planning. It estimates the cost of different execution strategies and selects the most performant one. ## 2. Project Structure and Organization The DuckDB project follows a well-defined directory structure: * **"src/":** Contains the core source code. * **"catalog/":** Manages database metadata (tables, schemas, functions, etc.). * **"common/":** Common utility functions and data structures used throughout the codebase. * **"execution/":** Implements query execution logic including the vectorized processing engine. * **"function/":** Contains built-in SQL functions. * **"main/":** Main entry point for the DuckDB library. * **"optimizer/":** Implements the query optimizer, including rule-based and cost-based optimizations. * **"parser/":** Responsible for parsing SQL queries. * **"planner/":** Creates the logical plan from the parsed SQL query. * **"storage/":** Implements storage management and data access. * **"transaction/":** Manages database transactions and concurrency control. * **"include/duckdb/":** Public header files for the DuckDB API. * **"test/":** Contains unit tests and integration tests. * **"extension/":** Location for extensions to DuckDB. * **"third_party/":** External libraries used by DuckDB. ### 2.1 Standards for Project Structure Contributions * **Do This:** Place new source code in the appropriate subdirectory within "src/". If a new component is introduced, create a dedicated subdirectory. * **Don't Do This:** Add source files to the root "src/" directory unless it's absolutely unavoidable. This keeps the codebase organized and navigable. **Example:** If you're adding a new string function, create the files "src/function/string/my_new_string_function.cpp" and "src/function/string/my_new_string_function.hpp". ### 2.2 Namespaces * **Do This:** All DuckDB code should reside within the "duckdb" namespace. Nested namespaces (e.g., "duckdb::storage") can be used to further organize code within modules. Use anonymous namespaces for file-local symbols. * **Don't Do This:** Use the global namespace or other top-level namespaces for DuckDB code. **Example:** """cpp namespace duckdb { namespace storage { class MyStorageClass { // ... }; } // namespace storage } // namespace duckdb """ ### 2.3 Directory Naming Conventions * **Do This:** Keep directory names lowercase and descriptive. Use underscores to separate words (e.g., "storage_manager"). * **Don't Do This:** Use camelCase or mixed-case directory names. Avoid abbreviations unless they are well-established within the project (e.g., "UDF" is acceptable rather than "user_defined_function"). ## 3. Coding Style and Formatting DuckDB follows a consistent coding style based on LLVM's style guide, with minor customizations. * **Do This:** * Use clang-format to automatically format code. A ".clang-format" file is provided in the root of the repository. * Follow the naming conventions for variables (snake_case), classes (PascalCase), and functions (camelCase, starting with a lowercase letter). * Use expressive and descriptive names. * Keep lines within a reasonable length (ideally under 120 characters). * **Don't Do This:** * Manually format code. Let clang-format handle the formatting. * Use cryptic or single-letter variable names (except in very localized contexts like loop counters). **Example:** """cpp // Correct class MyStorageManager { public: void initializeStorage(const string& path); private: string database_path_; }; // Incorrect class mystoragemanager { // Class name should be PascalCase public: void initstorage(const string& p); // Function starts with lowercase, variable name unclear private: string dbpath; // Variable name unclear, should be snake_case }; """ ## 4. Memory Management DuckDB employs a combination of manual memory management (using "new" and "delete"), smart pointers ("unique_ptr", "shared_ptr") for resource ownership, and a custom memory pool allocator for managing the lifetime of short-lived objects within the vectorized execution engine. ### 4.1 Standards for Memory Management * **Do This:** * Use "unique_ptr" for exclusive ownership of resources. This is the preferred way to manage memory in most cases. * Use "shared_ptr" only when shared ownership is explicitly required. Carefully consider the lifetime implications when using "shared_ptr" to avoid circular dependencies and memory leaks. * Use the memory pool allocator ("Allocator") for allocating short-lived objects within the vectorized execution engine, especially within inner loops or frequently called functions. This avoids the overhead of "new" and "delete" for each object. * When using raw pointers, ensure clear ownership transfer and deallocation, document the ownership semantics, and consider using RAII (Resource Acquisition Is Initialization) to tie the lifetime of the resource to the lifetime of an object. * **Don't Do This:** * Use raw pointers for resource ownership without clear ownership transfer. * Leak memory by failing to "delete" allocated objects. * Double-free memory. * Access memory after it has been freed (use-after-free). * Mix different memory allocation strategies haphazardly. **Example using "unique_ptr":** """cpp #include <memory> namespace duckdb { class MyObject { public: MyObject(int value) : value_(value) {} int GetValue() const { return value_; } private: int value_; }; void processObject(std::unique_ptr<MyObject> obj) { // 'obj' is exclusively owned here. std::cout << "Processing object with value: " << obj->GetValue() << std::endl; } // 'obj' is automatically deleted when it goes out of scope. std::unique_ptr<MyObject> createObject(int initialValue) { return std::make_unique<MyObject>(initialValue); } } // namespace duckdb """ **Example using the memory pool allocator:** """cpp namespace duckdb { class Vector { public: Vector(Allocator &allocator) : data_(allocator.Allocate(1024)) {} private: data_ptr_t data_; }; void myFunction(Allocator &allocator) { // Allocate a Vector using the provided allocator. Vector my_vector(allocator); } // Vector's memory is automatically deallocated when the Allocator's scope ends, usually at the end of query execution. } // namespace duckdb """ ## 5. Concurrency and Parallelism DuckDB leverages multi-threading for parallel query execution, particularly within the vectorized execution engine. ### 5.1 Standards for Concurrency * **Do This:** * Use appropriate locking mechanisms (e.g., "std::mutex", "std::shared_mutex") to protect shared data structures from race conditions. * Use fine-grained locking to minimize lock contention and maximize parallelism. * Consider using lock-free data structures for high-contention scenarios, but only when appropriate and with careful consideration of the complexity involved. The "atomic" types can be helpful here. * Utilize the task scheduler for managing parallel tasks. * **Don't Do This:** * Introduce data races by accessing shared data without proper synchronization. * Hold locks for extended periods, blocking other threads. * Create deadlocks by acquiring locks in inconsistent orders. **Example using "std::mutex":** """cpp #include <mutex> namespace duckdb { class SharedData { public: void incrementCounter() { std::lock_guard<std::mutex> lock(mutex_); // RAII-style locking counter_++; } int getCounter() const { std::lock_guard<std::mutex> lock(mutex_); return counter_; } private: int counter_ = 0; std::mutex mutex_; }; } // namespace duckdb """ ## 6. Error Handling Robust error handling is crucial for maintaining the stability and reliability of DuckDB. ### 6.1 Standards for Error Handling * **Do This:** * Use exceptions ("std::exception" or custom exception classes derived from it) to signal errors. Specifically "duckdb::Exception" and its subclasses are preferred. * Catch exceptions at appropriate levels and handle them gracefully. * Provide informative error messages that include the context of the error (e.g., the SQL query being executed, the file being processed). * Use "D_ASSERT" macros for internal assertions that should always be true. These assertions are enabled in debug builds and can help catch bugs early. * Return "Value" objects which contain error states when appropriate, especially for functions. * **Don't Do This:** * Ignore errors. * Use return codes for error handling unless there is a very specific reason to do so. Exceptions provide a much cleaner separation of concerns. * Throw generic exceptions without providing specific error information. * Use assertions for error conditions that can occur in production. Assertions are only enabled in debug builds; use exceptions for handling runtime errors. **Example using exceptions:** """cpp #include <stdexcept> #include "duckdb.hpp" namespace duckdb { void myFunction(int value) { if (value < 0) { throw InvalidInputException("Value must be non-negative"); } // ... } void anotherFunction() { try { myFunction(-1); } catch (const InvalidInputException& e) { std::cerr << "Error: " << e.what() << std::endl; // Handle the error appropriately (e.g., log it, return an error code). } catch (const Exception& e) { std::cerr << "DuckDB Error: " << e.what() << std::endl; // Catch DuckDB specific exceptions } catch (const std::exception& e) { std::cerr << "Standard exception: " << e.what() << std::endl; // Catch standard exceptions } catch (...) { std::cerr << "Unknown error occurred." << std::endl; // Handle unexpected errors. } } } // namespace duckdb """ ## 7. Logging DuckDB uses a logging system to record events and diagnostic information at different levels of severity. ### 7.1 Standards for Logging * **Do This:** * Use the logging macros (e.g., "D_LOG", "D_INFO", "D_DEBUG", "D_WARN", "D_ERROR") to log events at the appropriate severity level. * Include relevant context in log messages (e.g., the function name, the current state of the system). * Use structured logging to make log messages easier to parse and analyze. * **Don't Do This:** * Over-log, creating excessive noise in the logs. * Log sensitive information (e.g., passwords, API keys). * Use "std::cout" or "std::cerr" for logging. Use the DuckDB logging macros instead for consistency and configurability. **Example using logging macros:** """cpp #include "duckdb.hpp" namespace duckdb { void myFunction(int value) { D_DEBUG("myFunction called with value: {}", value); //Debug level message if (value < 0) { D_ERROR("Invalid value: {}", value); // Error Level message throw InvalidInputException("Value must be non-negative"); } D_INFO("Processing value: {}", value); } } // namespace duckdb """ ## 8. Extensibility DuckDB is designed to be extensible, allowing developers to add custom functions, table functions, and other extensions. ### 8.1 Standards for Extensibility * **Do This:** * Follow the documented API for creating custom functions and table functions. Refer to the DuckDB documentation for the latest API details. * Provide clear documentation and examples for your extensions. * Consider contributing your extensions back to the DuckDB community or publishing them as separate packages that others can use. * Ensure that extensions are thread-safe and do not introduce data races. Use proper synchronization mechanisms when accessing shared data structures. * **Don't Do This:** * Modify the core DuckDB code to add custom functionality. Use the extension API instead. * Introduce breaking changes to the extension API without careful consideration and communication with the community. * Create extensions that are insecure or unreliable. **Example Registering UDFs:** """cpp #include "duckdb.hpp" #include "duckdb/function/scalar_function.hpp" namespace duckdb { static void my_scalar_function(DataChunk &args, ExpressionState &state, Vector &result) { auto &input = args.data[0]; UnaryFunction::Execute<int32_t, int32_t>(input, result, args.size(), [&](int32_t input) { return input + 1; }); } class MyExtension : public Extension { public: std::string Name() override { return "my_extension"; } void Load(DatabaseInstance &instance) override { Connection con(instance); con.BeginTransaction(); auto &catalog = Catalog::GetCatalog(*con.GetContext()); ScalarFunction my_function("my_scalar_function", {LogicalType::INTEGER}, LogicalType::INTEGER, my_scalar_function); catalog.CreateFunction(*con.GetContext(), my_function); con.Commit(); } }; extern "C" { DUCKDB_EXTENSION_API void MyExtension_init(duckdb::DatabaseInstance &db) { db.RegisterExtension(std::make_unique<MyExtension>()); } DUCKDB_EXTENSION_API const char *MyExtension_version() { return duckdb::DuckDB::LibraryVersion(); } } } // namespace duckdb """ ## 9. Testing Tests are written using GTest and are located in the "test/" directory. Each component of the DuckDB system should have corresponding unit tests. ### 9.1 Testing Standards * **Do This:** * Write both unit tests and integration tests to cover different aspects of the code. Unit tests should focus on individual components, while integration tests should verify the interaction between multiple components. * Use descriptive test names that clearly indicate what is being tested. * Write tests that are reliable and repeatable. Avoid tests that depend on external factors (e.g., network connectivity, specific file system layout) unless those factors are explicitly part of the test. * Aim for achieving good test coverage by writing tests that exercise all code paths and edge cases. * **Don't Do This:** * Skip writing tests, even for small changes. * Write tests that are flaky or unreliable. Fix or remove such tests. * Commit code without running the tests first. **Example Test:** """cpp #include "catch.hpp" #include "duckdb.hpp" using namespace duckdb; TEST_CASE("Basic test", "[core]") { DBConfig config; DuckDB db(nullptr, &config); Connection con(db); REQUIRE(con.Query("SELECT 42")->GetValue(0, 0) == Value::INTEGER(42)); } TEST_CASE("Test that asserts","[common]") { // this test will only fail in debug mode REQUIRE_ASSERT(D_ASSERT(1 == 2)); } """ ## 10. Documentation Clear and up-to-date documentation is essential for making DuckDB easy to use and contribute to. ### 10.1 Standards for Documentation * **Do This:** * Document all public APIs (functions, classes, etc.) using Doxygen-style comments. * Provide clear and concise explanations of the purpose, usage, and limitations of the API. * Include examples to illustrate how to use the API. * Keep the documentation up-to-date as the code evolves. * Document internal design decisions and architectural choices to help other developers understand the codebase. * Use meaningful comments within the code to explain complex logic or non-obvious decisions. * **Don't Do This:** * Skip documenting public APIs. * Write documentation that is vague, incomplete, or inaccurate. * Let the documentation become outdated. **Example using Doxygen comments:** """cpp namespace duckdb { /** * @brief Initializes the storage manager. * @param path The path to the database file. */ void initializeStorage(const std::string& path); } // namespace duckdb """ ## 11. Specific Considerations for Core Architecture * **Catalog Management:** The "catalog/" directory is critical. Changes here affect the entire database. Code here requires extensive testing. Correct locking is critical to prevent database corruption. Ensure all catalog changes are properly logged for recovery purposes. * **Query Optimizer:** The "optimizer/" is performance-sensitive. New optimization rules should be carefully evaluated for their impact on query performance. Use benchmarks before and after changes. Pay special attention to corner cases for robustness. * **Storage Layer:** The "storage/" directory is responsible for data persistence. Correct implementations of the Write-Ahead Log (WAL) is critical for durability. Thoroughly test recovery scenarios after system crashes or power failures. Performance changes in the storage systems have a global impact. By adhering to these coding standards, developers can contribute to the DuckDB project in a consistent, maintainable, and high-quality manner. This collaborative effort ensures that DuckDB remains a powerful and reliable analytical database system.

# Testing Methodologies Standards for DuckDB This document outlines the testing methodologies standards for DuckDB, aiming to provide a clear and actionable guide for developers. The focus is on ensuring high-quality code through effective unit, integration, and end-to-end testing strategies, tailored specifically for DuckDB's unique features and architecture. ## 1. Overview of Testing Strategies DuckDB's testing strategy encompasses several layers to ensure reliability and correctness. These layers include unit tests, integration tests, and end-to-end tests. Each layer serves a distinct purpose and contributes to overall code quality. * **Unit Tests:** Focus on individual components or functions in isolation. They verify that each unit performs as expected under various conditions. * **Integration Tests:** Verify the interaction between different components or modules. They ensure that components work together correctly. * **End-to-End Tests:** Simulate real-world scenarios and validate the entire system from start to finish. They ensure that the system meets the desired requirements and performs accurately. ## 2. Unit Testing Standards Unit tests are the foundation of a robust testing suite. They isolate individual components, making it easier to identify and fix bugs. ### 2.1. Writing Effective Unit Tests * **Do This:** Write unit tests for every non-trivial function or method. * **Why:** Ensures that each part of the codebase works as intended, reducing the risk of regressions. * **Do This:** Use descriptive names for test functions to clearly indicate what is being tested. * **Why:** Improves readability and maintainability of the test suite. * **Do This:** Ensure each unit test covers a specific functionality or edge case. Keep unit tests small and focused. * **Why:** Easier to pinpoint the source of a failure and reduces debugging time. * **Don't Do This:** Write unit tests that are too broad or cover multiple functionalities in a single test. * **Why:** Makes it harder to understand the cause of failure and increases maintenance overhead. * **Don't Do This:** Write unit tests that depend on external resources or services. * **Why:** Makes tests brittle and unreliable. Unit tests should be isolated and repeatable. ### 2.2. Example: Unit Testing a DuckDB Function Assume we have a simple C++ function that calculates the square of a number: """c++ // src/math_utils.cpp #include <cmath> namespace duckdb { double square(double x) { return x * x; } } // namespace duckdb """ Here’s how you can write a unit test for it: """c++ // test/unittest/math_utils_test.cpp #include "catch.hpp" #include "duckdb.hpp" #include "src/math_utils.cpp" // Include the source file directly for unit testing using namespace duckdb; TEST_CASE("Square function test", "[math_utils]") { REQUIRE(square(2.0) == Approx(4.0)); REQUIRE(square(0.0) == Approx(0.0)); REQUIRE(square(-2.0) == Approx(4.0)); REQUIRE(square(3.14) == Approx(9.8596)); } """ * **Explanation:** * We use "catch.hpp" as the testing framework, which is common in DuckDB projects. * "TEST_CASE" defines a new test case with a descriptive name and tag. * "REQUIRE" asserts that the condition is true. "Approx" handles floating-point comparisons to account for potential precision issues. * Including the ".cpp" file directly is often necessary for unit testing due to DuckDB's internal build structure. ### 2.3. Common Anti-Patterns in Unit Testing * **Ignoring Edge Cases:** Failing to test boundary conditions or edge cases can lead to unexpected behavior in production. * **Example:** Not testing the "square" function with very large or very small numbers. * **Over-Mocking:** Using mocks excessively can make tests less reliable and harder to maintain. * **Why:** Over-mocking can hide underlying issues and makes it harder to refactor code. * **Not Cleaning Up:** Failing to clean up resources after a test can lead to resource leaks or interference with subsequent tests. * **Example:** Forgetting to close database connections or delete temporary files. ### 2.4. Modern Approaches * **Property-Based Testing:** Generate a large number of test cases automatically based on defined properties. * **Benefit:** Can uncover unexpected edge cases and improve test coverage. * **Example:** Testing that "square(x)" always returns a non-negative number for any real number "x". * **Mutation Testing:** Introduce small changes (mutations) to the code and verify that the tests fail. * **Benefit:** Helps identify weak tests that do not adequately cover the code. ## 3. Integration Testing Standards Integration tests verify the interaction between different components or modules. They ensure that these components work together correctly. ### 3.1. Writing Effective Integration Tests * **Do This:** Focus on testing the interfaces between components. * **Why:** Ensures that data is passed correctly and that components communicate effectively. * **Do This:** Use realistic test data that simulates real-world scenarios. * **Why:** Increases the likelihood of detecting integration issues. * **Do This:** Write tests that verify the expected behavior of the system as a whole. * **Why:** Ensures that the system meets the desired requirements. * **Don't Do This:** Write integration tests that are too granular or focused on individual component behavior. * **Why:** Overlaps with unit tests and increases maintenance overhead. * **Don't Do This:** Depend on unstable or unreliable external resources. * **Why:** Makes tests flaky and hard to reproduce. ### 3.2. Example: Integration Testing with DuckDB Suppose we have a module that imports data from a CSV file into a DuckDB database and another module that performs analytics on the data. Here’s how you can write an integration test: """c++ // test/integration/csv_import_test.cpp #include "catch.hpp" #include "duckdb.hpp" #include <fstream> using namespace duckdb; TEST_CASE("CSV import and analytics integration test", "[integration]") { // Create a temporary CSV file std::ofstream csv_file("test.csv"); csv_file << "id,name,value\n"; csv_file << "1,Alice,10\n"; csv_file << "2,Bob,20\n"; csv_file.close(); // Initialize DuckDB database DuckDB db(":memory:"); Connection con(db); // Import data from CSV file con.Query("CREATE TABLE my_table AS SELECT * FROM read_csv_auto('test.csv')"); // Perform analytics auto result = con.Query("SELECT SUM(value) FROM my_table"); // Verify the result REQUIRE(result->GetValue(0, 0).GetValue<int64_t>() == 30); // Clean up the temporary file std::remove("test.csv"); } """ * **Explanation:** * We create a temporary CSV file with sample data. * We initialize a DuckDB database in memory. * We import the data from the CSV file into a table using "read_csv_auto". * We perform a simple aggregation query to calculate the sum of values. * We verify that the result matches the expected value. * Finally, we clean up the temporary CSV file. ### 3.3. Common Anti-Patterns in Integration Testing * **Ignoring Error Handling:** Failing to test how the system handles errors during integration can lead to unexpected behavior in production. * **Example:** Not testing what happens when the CSV file is malformed or missing. * **Overlapping with Unit Tests:** Writing integration tests that duplicate the functionality of unit tests. * **Why:** Increases maintenance overhead without providing additional value. * **Using Hardcoded Values:** Using hardcoded values in tests can make them brittle and hard to maintain. * **Example:** Hardcoding the expected sum of values instead of calculating it dynamically. ### 3.4. Modern Approaches * **Containerization:** Use Docker containers to create isolated and reproducible test environments. * **Benefit:** Ensures that tests run consistently across different environments. * **Test Data Management:** Use dedicated tools to manage test data and ensure data consistency. * **Benefit:** Reduces the risk of data-related issues and improves test reliability. ## 4. End-to-End Testing Standards End-to-end tests simulate real-world scenarios and validate the entire system from start to finish. They ensure that the system meets the desired requirements and performs accurately. ### 4.1. Writing Effective End-to-End Tests * **Do This:** Simulate realistic user interactions and workflows. * **Why:** Increases the likelihood of detecting issues that users might encounter. * **Do This:** Verify that the system meets the business requirements. * **Why:** Ensures that the system provides the expected value. * **Do This:** Write tests that cover the most critical user journeys. * **Why:** Focuses testing efforts on the most important functionalities. * **Don't Do This:** Write end-to-end tests that are too detailed or cover every possible scenario. * **Why:** Increases maintenance overhead and can make tests brittle. * **Don't Do This:** Rely on manual setup or configuration. * **Why:** Makes tests hard to automate and reproduce. ### 4.2. Example: End-to-End Testing with DuckDB Suppose we have a system that allows users to upload CSV files, perform SQL queries on the data, and download the results. Here’s how you can write an end-to-end test: """python # test/e2e/upload_query_download_test.py import duckdb import os def test_upload_query_download(): # Create a temporary CSV file with open("test.csv", "w") as f: f.write("id,name,value\n") f.write("1,Alice,10\n") f.write("2,Bob,20\n") # Initialize DuckDB database con = duckdb.connect(database=':memory:', read_only=False) # Upload data from CSV file con.execute("CREATE TABLE my_table AS SELECT * FROM read_csv_auto('test.csv')") # Perform SQL query result = con.execute("SELECT SUM(value) FROM my_table").fetchone()[0] # Verify the result assert result == 30 # Download the result (simulated) - write to file with open("result.txt", "w") as f: f.write(str(result)) # Clean up the temporary file os.remove("test.csv") os.remove("result.txt") """ * **Explanation:** * Uses pytest as a framework * We create a temporary CSV file with sample data. * We initialize a DuckDB database in memory. * We upload the data from the CSV file into a table using "read_csv_auto". * We perform a SQL query to calculate the sum of values. * We verify that the result matches the expected value. * Finally, we clean up the temporary file. We also simulate "downloading" the result by writing it into a separate file and clearing that up too. ### 4.3. Common Anti-Patterns in End-to-End Testing * **Ignoring Performance:** Failing to test the performance of the system during end-to-end tests can lead to performance bottlenecks in production. * **Example:** Not measuring the time it takes to upload, query, and download data. * **Testing Implementation Details:** Writing tests that are tightly coupled to the implementation details of the system. * **Why:** Makes tests brittle and hard to maintain. * **Using Manual Assertions:** Relying on manual inspection of the system to verify the results. * **Why:** Makes tests hard to automate and reproduce. ### 4.4. Modern Approaches * **Behavior-Driven Development (BDD):** Use BDD frameworks like Cucumber to define tests in a human-readable format. * **Benefit:** Improves collaboration between developers, testers, and business stakeholders. * **Continuous Integration/Continuous Deployment (CI/CD):** Automate the execution of end-to-end tests as part of the CI/CD pipeline. * **Benefit:** Provides rapid feedback and ensures that the system is always in a deployable state. ## 5. DuckDB-Specific Testing Considerations Due to DuckDB's specific architecture (in-process, embedded), certain aspects of testing require special attention. * **Concurrency:** When testing concurrent operations, ensure proper isolation to prevent race conditions and data corruption. Use transactions and locking mechanisms as needed. * **Memory Management:** Pay close attention to memory usage during tests, as DuckDB operates within the application's memory space. Use tools to monitor memory consumption and detect leaks. * **Storage:** When testing persistent storage features, ensure that data is properly persisted and recovered after restarts. Verify the integrity of the stored data. * **Extensions:** When testing DuckDB extensions, ensure that the extensions are properly loaded and initialized. Verify that the extension functions work as expected. ## 6. Test Data Generation Creating realistic and diverse test data is crucial for effective testing. * **Use data generation tools:** Libraries such as Faker (Python) or other data synthesis tools can generate data that mimics real-world datasets. * **Utilize existing datasets:** If possible, leverage anonymized or sample datasets that represent the type of data your DuckDB instance will handle. * **Coverage:** Ensure test data covers a wide range of values, including edge cases, nulls, and invalid data, to ensure comprehensive testing. ## 7. Performance and Regression Testing * **Implement performance benchmarks:** Regularly run performance benchmarks for key queries and operations to detect performance regressions. * **Automate regression testing:** Create regression tests that capture known bugs or performance issues. Ensure these tests run with every code change to prevent the reintroduction of previously resolved problems. ## 8. Collaboration with AI Coding Assistants When using AI coding assistants like GitHub Copilot, provide clear and specific instructions related to testing. * **Contextualize code generation:** When generating test code, provide specific details about the functionality being tested, expected inputs, and expected outputs. * **Review suggestions carefully:** Always review AI-generated test code to ensure it accurately reflects the testing requirements and standards. Do not blindly accept AI-generated suggestions. * **Leverage AI for test case generation**: Where appropriate, prompt the AI to generate additional test cases, especially boundary conditions and edge cases. ## 9. Conclusion Adhering to these testing methodologies standards will ensure that DuckDB projects are robust, reliable, and maintainable. By incorporating thorough unit, integration, and end-to-end testing strategies, developers can build high-quality data solutions with confidence. Ongoing refinement and adaptation of these standards based on evolving best practices and project-specific needs are crucial for continued success.