localvectordb_server package
localvectordb_server/__init__.py
FastAPI-based server for interacting with localvectordb.LocalVectorDB via HTTP with structured logging, error handling, and performance monitoring.
The heavy server dependencies (fastapi, uvicorn, …) belong to the optional
server extra, so create_app is exposed lazily (PEP 562): importing this
package must stay possible on a base install, and the ImportError users hit
should tell them which extra to install.
Subpackages
- localvectordb_server.cli package
- localvectordb_server.mcp package
- Submodules
- localvectordb_server.mcp.config module
- localvectordb_server.mcp.server module
MCPManagerlifespan()register_tool()register_mcp_tool()list_databases()get_database_info()query_database()find_related_documents()filter_documents()get_document()check_documents_exist()get_metadata_schema()get_system_info()create_database()delete_database()upsert_documents()update_document()patch_document()delete_document()update_metadata_schema()run_mcp_server()
- Submodules
- localvectordb_server.utils package
Submodules
- localvectordb_server.config module
BaseSettingsEmbeddingSettingsDatabaseSettingsDatabaseSettings.root_dirDatabaseSettings.timeoutDatabaseSettings.connection_pool_sizeDatabaseSettings.enable_gpuDatabaseSettings.enable_ftsDatabaseSettings.faiss_index_typeDatabaseSettings.faiss_index_hnsw_flat_neighborsDatabaseSettings.faiss_index_lsh_bitsDatabaseSettings.mmap_indexDatabaseSettings.chunk_sizeDatabaseSettings.chunk_overlapDatabaseSettings.chunking_methodDatabaseSettings.default_metadata_schemaDatabaseSettings.validate()DatabaseSettings.__init__()
BackupSettingsBackupSettings.enabledBackupSettings.default_locationBackupSettings.retention_daysBackupSettings.max_backupsBackupSettings.compression_typeBackupSettings.compression_levelBackupSettings.auto_backup_enabledBackupSettings.auto_backup_interval_hoursBackupSettings.auto_backup_typeBackupSettings.backup_chunk_sizeBackupSettings.verify_backupsBackupSettings.validate()BackupSettings.__init__()
MigrationSettingsMigrationSettings.enabledMigrationSettings.migration_dirMigrationSettings.auto_migrateMigrationSettings.backup_before_migrationMigrationSettings.require_confirmationMigrationSettings.allow_destructive_migrationsMigrationSettings.max_rollback_stepsMigrationSettings.migration_template_authorMigrationSettings.migration_template_formatMigrationSettings.validate()MigrationSettings.__init__()
ExtractionSettingsSecuritySettingsSecuritySettings.require_api_keySecuritySettings.api_key_headerSecuritySettings.trusted_hostsSecuritySettings.key_database_pathSecuritySettings.default_key_expiry_daysSecuritySettings.auto_prune_expired_keysSecuritySettings.key_audit_loggingSecuritySettings.auth_log_levelSecuritySettings.warn_expiring_daysSecuritySettings.cors_enabledSecuritySettings.cors_allowed_originsSecuritySettings.cors_allowed_methodsSecuritySettings.cors_allowed_headersSecuritySettings.cors_max_ageSecuritySettings.security_headers_enabledSecuritySettings.force_httpsSecuritySettings.strict_transport_securitySecuritySettings.strict_transport_security_max_ageSecuritySettings.content_security_policySecuritySettings.content_type_nosniffSecuritySettings.x_frame_optionsSecuritySettings.x_xss_protectionSecuritySettings.referrer_policySecuritySettings.validate()SecuritySettings.__init__()
ServerSettingsServerSettings.debugServerSettings.environmentServerSettings.hostServerSettings.portServerSettings.log_levelServerSettings.log_formatServerSettings.file_upload_enabledServerSettings.max_request_sizeServerSettings.enable_structured_loggingServerSettings.enable_performance_loggingServerSettings.enable_rate_limitingServerSettings.rate_limitServerSettings.rate_limit_storage_uriServerSettings.cache_enabledServerSettings.cache_ignore_errorsServerSettings.cache_timeoutServerSettings.cache_key_prefixServerSettings.cache_typeServerSettings.cache_settingsServerSettings.redis_hostServerSettings.redis_portServerSettings.redis_passwordServerSettings.redis_dbServerSettings.redis_urlServerSettings.redis_socket_timeoutServerSettings.redis_socket_connect_timeoutServerSettings.filesystem_cache_dirServerSettings.filesystem_cache_thresholdServerSettings.memcached_serversServerSettings.memcached_usernameServerSettings.memcached_passwordServerSettings.db_registry_typeServerSettings.db_registry_settingsServerSettings.use_single_cacheServerSettings.proxy_enabledServerSettings.proxy_settingsServerSettings.trusted_proxiesServerSettings.securityServerSettings.validate()ServerSettings.__init__()
ConfigConfig.databaseConfig.embeddingConfig.serverConfig.backupConfig.migrationConfig.extractionConfig.validate()Config.from_file()Config.from_dict()Config.from_env()Config.update_from_dict()Config.to_flask_config()Config.generate_toml()Config.to_dict()Config.apply_common_schema()Config.merge()Config.__init__()
load_config()
- localvectordb_server.keymanager module
PermissionLevelKeyRecordKeyRecord.idKeyRecord.key_hashKeyRecord.descriptionKeyRecord.created_atKeyRecord.expires_atKeyRecord.last_usedKeyRecord.activeKeyRecord.created_byKeyRecord.permission_levelKeyRecord.plain_keyKeyRecord.is_expiredKeyRecord.days_until_expiryKeyRecord.to_dict()KeyRecord.from_db_row()KeyRecord.__init__()
KeyManagerKeyManager.SCHEMA_VERSIONKeyManager.KEY_PREFIXKeyManager.KEY_LENGTHKeyManager.KEY_CHARSETKeyManager.__init__()KeyManager.create_key()KeyManager.validate_key()KeyManager.validate_key_with_permissions()KeyManager.get_key()KeyManager.list_keys()KeyManager.revoke_key()KeyManager.rotate_key()KeyManager.prune_expired()KeyManager.get_stats()
get_key_manager()