Documentation Index

This directory contains comprehensive documentation for the Apache IoTDB Node.js client.

📚 Documentation Categories

📋 Documentation Overview

• Documentation Review Complete - Complete review and organization report (EN)
• Documentation Summary (中文) - 文档审查和组织总结

Getting Started

• Main README - Project overview, installation, and quick start
• Contributing Guidelines - How to contribute to the project
• Changelog - Version history and release notes

API & Usage

• Implementation Guide - Architecture and core components
• Data Types - Supported data types and usage
• TypeScript Examples - TypeScript usage examples
• Thrift Documentation - Thrift code generation and definitions
• SessionDataSet Guide - Iterator pattern for query results
• Tablet Interfaces - TreeTablet vs TableTablet guide
• ColumnCategory Usage - Table model column categories

User Guides

• Tree Model (Timeseries)
  • English - Tree model user guide
  • 中文 - 树模型用户指南
• Table Model (Relational)
  • English - Table model user guide
  • 中文 - 表模型用户指南

Performance & Optimization

• Performance Documentation Index ⭐ START HERE for performance
• Performance Guide - Optimization guide with benchmarks and best practices
• pg-Inspired Optimizations - Implementation details of pg nodejs patterns
• Performance Analysis Summary - Analysis of pool optimization testing
• Redirection Design - Client-side redirection optimization

Development

• Build Infrastructure - Build system analysis
• Debugging E2E Tests - E2E testing guide
• Test Database Reference - Test database setup

Project Information

• Project Status - Implementation status and roadmap
• Planning Document - Detailed project planning and architecture decisions
• E2E Test Status - End-to-end testing status
• Tablet Refactoring Summary - Summary of tablet interface changes

🔗 Quick Links

For Users

• New to IoTDB? Start with the Main README
• Using TypeScript? Check TypeScript Examples
• Querying data? See SessionDataSet Guide
• Need specific data types? See Data Types
• Using tree model? See Tree Model User Guide or 中文版
• Using table model? See Table Model User Guide or 中文版
• Want better performance? Check Performance Guide

For Contributors

• Want to contribute? Read Contributing Guidelines
• Building the project? See Build Infrastructure
• Running tests? Check Debugging E2E Tests
• Understanding optimizations? See pg-Inspired Optimizations

For Developers

• Understanding the code? Read Implementation Guide
• Working with Thrift? See Thrift Documentation
• Project roadmap? Check Project Status
• Performance internals? See pg-Inspired Optimizations

📖 Documentation Structure

docs/
├── README.md                          # This file
├── implementation.md                  # Architecture & implementation
├── data-types.md                      # Data type reference
├── typescript-examples.md             # TypeScript usage
├── thrift.md                          # Thrift generation
├── sessiondataset-guide.md            # Query result handling
├── tablet-interfaces.md               # TreeTablet vs TableTablet
├── COLUMNCATEGORY_USAGE.md            # Column categories
├── performance-guide.md               # Performance optimization guide
├── pg-inspired-optimizations.md       # pg nodejs patterns implementation
├── redirection-design.md              # Client-side redirection
├── user-guide-tree.md                 # Tree model guide (EN)
├── user-guide-tree-zh.md              # Tree model guide (中文)
├── user-guide-table.md                # Table model guide (EN)
├── user-guide-table-zh.md             # Table model guide (中文)
├── project-status.md                  # Project status
├── plan.md                            # Project planning
└── development/                       # Development guides
    ├── build-infrastructure.md
    ├── debugging-e2e.md
    └── test-database.md

Root level summaries:
├── PERFORMANCE_ANALYSIS_SUMMARY.md    # Pool optimization testing analysis
├── E2E_TEST_STATUS.md                 # E2E testing status
└── TABLET_REFACTORING_SUMMARY.md      # Tablet interface changes

🚀 Additional Resources

• GitHub Workflows - CI/CD documentation
• Benchmark Tools - Performance testing tools
• Examples - Code examples and samples
• Thrift Schema - Thrift schema documentation
• Apache IoTDB Documentation

📝 Contributing to Documentation

Found an error or want to improve the documentation? Please:

1. Check our Contributing Guidelines
2. Open an issue or submit a pull request
3. Follow the documentation style guide (keep it clear, concise, and helpful)

Last Updated: 2026-02-03