PHP download

Download the PHP package zestic/weaviate-php-client without Composer

On this page you can find all versions of the php package zestic/weaviate-php-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download zestic/weaviate-php-client
More information about zestic/weaviate-php-client
Files in zestic/weaviate-php-client

Vendor zestic
Package weaviate-php-client
Short Description A modern PHP client for Weaviate vector database with comprehensive query capabilities and multi-tenancy support
License Apache-2.0

Keywords search query filtering ai multi-tenancy graphql machine-learning weaviate vector-database

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.

Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.

Please rate this library. Is it a good library?

Example code of zestic/weaviate-php-client

Informations about the package weaviate-php-client

Weaviate PHP Client

A modern PHP client for Weaviate vector database with multi-tenancy support.

License

This project is licensed under the Apache License 2.0. See the LICENSE file for details.

Requirements

PHP 8.3 or higher
Composer
Docker and Docker Compose (for integration tests)

Installation

Examples

For comprehensive examples, see the examples directory:

Getting Started - Complete end-to-end example with multi-tenancy
Error Handling - Comprehensive error handling patterns
Schema Management - Collection and schema operations

Basic Usage

Quick Start with connectToLocal

Schema Management

The PHP client provides comprehensive schema management capabilities:

Advanced Usage with Manual Connection

Multi-Tenancy

Weaviate supports multi-tenancy, allowing you to isolate data for different tenants within the same collection. This PHP client provides comprehensive tenant management capabilities.

Creating Multi-Tenant Collections

Managing Tenants

Tenant Activity Status Management

Tenants can have different activity statuses that control how their data is stored and accessed:

ACTIVE: Tenant is fully active, data immediately accessible
INACTIVE: Tenant is inactive, data stored locally but not accessible
OFFLOADED: Tenant is inactive, data stored in cloud storage
OFFLOADING: (Read-only) Tenant is being moved to cloud storage
ONLOADING: (Read-only) Tenant is being activated from cloud storage

Working with Tenant Data

Once tenants are created, you can work with tenant-specific data:

Tenant Management Best Practices

Tenant Naming: Use consistent, meaningful tenant names (e.g., customer IDs, organization slugs)
Status Management: Use INACTIVE for temporary suspension, OFFLOADED for long-term storage
Batch Operations: Create/update multiple tenants at once for better performance
Error Handling: Always check tenant existence before performing operations
Data Isolation: Remember that tenant data is completely isolated

Query Operations

The PHP client provides a powerful query builder with comprehensive filtering capabilities, matching the Python client v4 API patterns.

Basic Queries

Cross-Reference Management

The PHP client now supports full cross-reference management, achieving parity with Python client v4.

Adding Cross-References

Managing Cross-References

Cross-Reference Querying

Query objects based on their cross-referenced properties, matching Python client v4 patterns.

Filtering by Cross-References

Including Cross-References in Results

Aggregation Queries

Perform aggregation operations with grouping and metrics, matching Python client v4 functionality.

Basic Aggregations

Property Filtering

Complex Filtering

ID Filtering

Convenience Methods

Multi-Tenant Queries

Configurable Default Fields

Error Handling

Development

Running Tests

Unit Tests (No External Dependencies)

Integration Tests (Requires Weaviate)

Option 1: Using Docker (Recommended)

Option 2: Using External Weaviate Instance

Test Coverage

Code Quality

Features

Phase 1 (Current)

✅ Core client with multi-tenancy support
✅ Connection layer with authentication
✅ Collections API for basic CRUD operations
✅ Data operations with tenant support
✅ Query builder with comprehensive filtering (Python client v4 compatible)
✅ GraphQL query generation and execution
✅ Advanced filtering with property, ID, and complex filters

Planned Features

Batch operations
Vector operations
Hybrid search
Advanced aggregations

Architecture

The client follows a modular architecture:

WeaviateClient: Main entry point
Connection: HTTP communication layer
Auth: Authentication mechanisms
Collections: Collection management
Data: Object CRUD operations
Schema: Schema management

Contributing

Fork the repository
Create a feature branch
Write tests for your changes
Ensure all tests pass
Submit a pull request

Testing Philosophy

This project follows Test-Driven Development (TDD):

Tests drive the implementation
High test coverage is maintained
Both unit and integration tests are included

Documentation

API Reference

Complete API Documentation - Detailed API reference with examples
Error Handling Guide - Comprehensive error handling and retry strategies
Python Client Migration Guide - For developers familiar with the Python client

Key Features

Three Connection Methods: connectToLocal(), connectToWeaviateCloud(), connectToCustom()
Full Python Client Parity: Same functionality and patterns as the Python client
Multi-Tenancy Support: Built-in support for tenant-specific operations
Type Safety: Full PHPStan level 8 compliance with comprehensive type annotations
Comprehensive Testing: Unit, integration, and mock tests with 200+ assertions
Advanced Error Handling: Complete exception hierarchy with retry mechanisms
Automatic Retries: Exponential backoff for transient failures

Support

For issues and questions, please use the GitHub issue tracker.

All versions of weaviate-php-client with dependencies

PHP Build Version

Package Version

Version v0.5.0 Release 07. Aug 2025
create-project require 0 people chose require and
0 people chose create-project.

Download

Download latest version of weaviate-php-client from vendor zestic

Requires php Version ^8.3
psr/http-client Version ^1.0
psr/http-factory Version ^1.0
psr/http-message Version ^1.0 || ^2.0
ramsey/uuid Version ^4.7

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package zestic/weaviate-php-client contains the following files

Loading the files please wait ....