VeeDB

User Guide:

  • Installation
    • Requirements
    • Installation Methods
      • From PyPI
      • From Source
    • Development Installation
    • Virtual Environment
    • Verification
    • Troubleshooting
      • Common Issues
      • Platform-Specific Notes
  • Quick Start Guide
    • Basic Setup
    • Simple Example
    • Authentication
      • Getting an API Token
    • Using Different Endpoints
    • Filter Validation
    • Complex Queries
    • Error Handling
    • Sandbox Mode
    • Configuration Options
    • Best Practices
    • Next Steps
  • Filter Validation Guide
    • Key Features
    • Basic Usage
    • Direct Validation
    • Field Discovery
    • Nested Field Validation
    • Error Handling and Suggestions
    • Performance Considerations
      • Schema Caching
      • Disabling Validation
    • Advanced Usage
      • Custom Validation Logic
      • Building Validation Tools
  • Authentication
    • Getting an API Token
    • Token Permissions
    • Using API Tokens
      • Environment Variables (Recommended)
      • Direct Token Usage
      • Configuration Files
    • Authentication Verification
    • Authenticated Operations
      • User Information
      • User List Management
      • Release List Management
    • Error Handling
    • Token Security Best Practices
    • Example: Secure Token Management
    • Troubleshooting
  • Examples
    • Basic Queries
      • Simple Visual Novel Search
      • Character Search
      • Release Information
    • Advanced Filtering
      • Complex Filter Expressions
      • Nested Field Queries
    • Filter Validation
      • Validating Filters Before Use
      • Getting Available Fields
      • Auto-correction Example
    • Authentication Examples
      • User List Management
      • Release List Example
    • Error Handling Examples
      • Comprehensive Error Handling
      • Retry Logic Example
    • Performance Examples
      • Batch Processing
      • Caching Results
    • Configuration Examples
      • Custom Configuration
    • Running the Examples

Development:

  • Contributing
    • Development Setup
      • Prerequisites
      • Setting up the Development Environment
    • Project Structure
    • Making Changes
      • Code Style
      • Testing
      • Documentation
    • Types of Contributions
      • Bug Reports
      • Feature Requests
      • Code Contributions
      • Pull Request Guidelines
    • API Design Principles
      • Type Safety
      • Async/Await
      • Error Handling
      • Performance
    • Working with the VNDB API
      • API Documentation
      • Schema Validation
      • Authentication
    • Release Process
    • Getting Help
    • Code of Conduct
  • Changelog
    • Unreleased
      • Added
      • Changed
      • Fixed
    • 0.1.1 (2024-12-01)
      • Added
      • API Endpoints Supported
      • Filter Validation Features
      • Dependencies

API Reference:

  • Client API
  • Main VNDB Client
  • Endpoint-Specific Clients
    • Visual Novel Client
      • _VNClient
        • _VNClient.__init__()
    • Character Client
      • _CharacterClient
        • _CharacterClient.__init__()
    • Release Client
      • _ReleaseClient
        • _ReleaseClient.__init__()
    • Producer Client
      • _ProducerClient
        • _ProducerClient.__init__()
    • Staff Client
      • _StaffClient
        • _StaffClient.__init__()
    • Tag Client
      • _TagClient
        • _TagClient.__init__()
    • Trait Client
      • _TraitClient
        • _TraitClient.__init__()
    • Quote Client
      • _QuoteClient
        • _QuoteClient.__init__()
    • User List Client
      • _UlistClient
        • _UlistClient.__init__()
        • _UlistClient.query()
        • _UlistClient.get_labels()
        • _UlistClient.update_entry()
        • _UlistClient.delete_entry()
        • _UlistClient.query_all_pages()
        • _UlistClient.query_paginated()
    • Release List Client
      • _RlistClient
        • _RlistClient.__init__()
        • _RlistClient.update_entry()
        • _RlistClient.delete_entry()
      • Base Entity Client
        • _BaseEntityClient
      • Client Methods Reference
    • Query Methods
    • List Management Methods
    • Main Client Methods
    • Validation Methods
    • Cache Management
    • Context Manager Support
  • Validation System
    • Filter Validator
    • Schema Cache
    • Validation Methods
      • Filter Validation
      • Field Suggestions
      • Available Fields
      • Endpoint Discovery
    • Schema Cache Methods
      • Cache Status
      • Cache Management
    • Validation Examples
      • Basic Validation
      • Complex Filter Validation
      • Auto-Correction
      • Field Discovery
      • Custom Validator Configuration
    • Error Types
      • Field Errors
      • Syntax Errors
      • Usage Errors
    • Suggestions Algorithm
    • Best Practices
    • Integration Tips
  • Type Definitions
    • Common Types
      • Query and Response Types
      • Identifier Types
      • Enumeration Types
    • Request Types
      • List Update Payloads
    • Entity Types
      • Visual Novel Entities
        • VNTitle
        • VNImageInfo
        • VNScreenshotRelease
        • VNTagLink
        • VNDeveloper
        • VNEdition
        • VNStaffLink
        • VNVoiceActor
        • VNVAStaff
        • VNVACharacter
        • VN
        • VNRelation
      • Character Entities
        • CharacterImageInfo
        • CharacterVNLink
        • CharacterTraitLink
        • Character
      • Producer Entities
        • Producer
      • Release Entities
        • ReleaseLanguageSpecific
        • ReleaseMedia
        • ReleaseVNLink
        • ReleaseProducerLink
        • ReleaseImage
        • Release
      • Staff Entities
        • StaffAlias
        • Staff
      • Tag Entities
        • Tag
      • Trait Entities
        • Trait
      • Quote Entities
        • Quote
      • User List Entities
        • UlistLabelInfo
        • UlistReleaseInfo
        • UlistItem
        • UlistLabel
      • User Entities
        • User
        • AuthInfo
        • UserStats
    • Type Usage Examples
      • Creating Query Requests
      • Working with Response Data
      • Updating User Lists
      • Working with Enums
    • Type Annotations
    • Optional Fields
    • Union Types
    • Generic Types
    • Dataclass Features
    • Type Validation
    • Best Practices
    • IDE Support
  • Exception Handling
    • Exception Hierarchy
    • Base Exception
    • Specific Exceptions
      • Authentication Errors
      • Rate Limiting Errors
      • Invalid Request Errors
      • Not Found Errors
      • Server Errors
      • Too Much Data Errors
    • Error Handling Patterns
      • Basic Error Handling
      • Specific Error Handling
      • Retry Logic with Exponential Backoff
      • Validation-First Approach
      • Graceful Degradation
      • Error Context Preservation
    • Logging Best Practices
    • Testing Error Conditions
    • Best Practices
VeeDB
  • Python Module Index

Python Module Index

v
 
v
- veedb
    veedb.apitypes.entities.character
    veedb.apitypes.entities.producer
    veedb.apitypes.entities.quote
    veedb.apitypes.entities.release
    veedb.apitypes.entities.staff
    veedb.apitypes.entities.tag
    veedb.apitypes.entities.trait
    veedb.apitypes.entities.ulist
    veedb.apitypes.entities.user
    veedb.apitypes.entities.vn

© Copyright 2026, Sub0X.

Built with Sphinx using a theme provided by Read the Docs.