Quick Start
Set Up Xata Database
- Create account at xata.io
- Create a new database
- Get PostgreSQL connection string from Settings
- Set environment variable:
Installation
- pip
- Environment Variables
Configuration Options
| Option | Type | Default | Description |
|---|---|---|---|
database_url | str | None | Xata PostgreSQL connection URL |
max_retries | int | 3 | Retries for serverless cold starts |
retry_delay | float | 0.5 | Base delay between retries |
auto_create_tables | bool | True | Create conversation tables |
enable_search | bool | True | Enable full-text search indexing |
Usage Patterns
Using Convenience Class
Manual Configuration with Search
Full Lifecycle with Search & Analytics
Xata-Specific Features
Built-in Full-Text Search
All conversation data is automatically indexed for search:Vector Search for Similarity
Store and search embeddings alongside conversations:Real-Time Analytics
Track conversation patterns and metrics:File Storage Integration
Store conversation-related files directly in Xata:Best Practices
Optimize Search Performance
Optimize Search Performance
Structure conversation data for effective search:
Use Analytics for Insights
Use Analytics for Insights
Leverage Xata’s analytics to improve agent performance:
Manage Data Growth
Manage Data Growth
Monitor database size and implement archiving:
Leverage Multi-Modal Data
Leverage Multi-Modal Data
Store different data types together:
Environment Variables
| Variable | Required | Format | Example |
|---|---|---|---|
XATA_DATABASE_URL | ✅ | postgresql://workspace:key@region.sql.xata.sh:5432/db:branch | postgresql://ws_123:xau_abc@us-east-1.sql.xata.sh:5432/chatdb:main?sslmode=require |
OPENAI_API_KEY | ✅ | sk-... | sk-1234567890abcdef... |
Feature Comparison
| Feature | Xata | Standard PostgreSQL | Benefit |
|---|---|---|---|
| Full-Text Search | ✅ Built-in | Manual setup | Instant search capability |
| Vector Search | ✅ Native | Extension required | AI/ML integration |
| File Storage | ✅ Integrated | Separate service | Unified data platform |
| Analytics | ✅ Built-in | Custom queries | Conversation insights |
| Branching | ✅ Git-like | Complex | Easy development workflow |
Troubleshooting
Search Index Issues
If search isn’t working:File Upload Limits
Xata has file size limits:Connection String Format
Ensure proper connection string format:Branch Management
If using multiple branches:Related
Cloud Databases Overview
Compare all cloud database providers
Search & Analytics
Advanced search and analytics features

