Skip to content

Commit b824a5b

Browse files
committed
chore(changelog): update changelog for version 1.0.0 release
- Document notable changes and features in version 1.0.0 - Include comprehensive list of added functionalities - Fix previous changelog entries for clarity
1 parent 3c8063f commit b824a5b

File tree

1 file changed

+38
-47
lines changed

1 file changed

+38
-47
lines changed

CHANGELOG.md

Lines changed: 38 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -5,43 +5,56 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
## [Unreleased]
9-
10-
## [0.3.0] - 2025-01-28
11-
12-
### Added
13-
- Enhanced GitHub release workflow with improved changelog extraction
14-
- Better error handling in CI/CD pipeline
15-
16-
### Fixed
17-
- Changelog parsing in release notes generation
18-
19-
## [0.2.1] - 2025-01-27
20-
21-
### Fixed
22-
- PyPI publishing workflow with tag-based releases
23-
- Changelog extraction in GitHub releases
24-
25-
## [0.2.0] - 2025-01-27
8+
## [1.0.0] - 2025-10-28
269

2710
### Added
11+
- `SQLiteVecClient` class for CRUD and similarity search operations
12+
- `create_table()` - Initialize schema with configurable dimensions and distance metrics
13+
- `add()` - Insert texts with embeddings
14+
- `update()` - Update existing records
2815
- `update_many()` - Bulk update multiple records in a single transaction
16+
- `delete()` - Remove records by rowid
17+
- `get()` - Fetch single record by rowid
18+
- `get_many()` - Fetch multiple records
2919
- `get_all()` - Memory-efficient generator for iterating over all records
20+
- `get_by_text()` - Find records by exact text match
21+
- `get_by_metadata()` - Find records by metadata JSON match
22+
- `list_all()` - List all records with pagination
23+
- `similarity_search()` - Vector similarity search with configurable top_k
24+
- `count()` - Get total record count
25+
- `clear()` - Remove all records
26+
- `drop_table()` - Delete table and index
3027
- `transaction()` - Context manager for atomic multi-operation transactions
31-
- Comprehensive tests for bulk operations (91%+ coverage)
32-
- Updated batch_operations.py example with new features
33-
- CONTRIBUTING.md with contribution guidelines
34-
- CHANGELOG.md for tracking changes
28+
- Support for text, metadata (JSON), and float32 embeddings
29+
- Automatic synchronization between base table and vec0 index via triggers
30+
- Context manager support for automatic connection cleanup
31+
- Distance metrics: cosine, L2, L1
3532
- Python logging module integration with configurable log levels
33+
- Type hints and dataclasses for typed results
34+
- Comprehensive test suite with 91%+ coverage
3635
- Complete CI/CD pipeline with GitHub Actions
36+
- Enhanced GitHub release workflow with improved changelog extraction
37+
- Better error handling in CI/CD pipeline
3738
- Pre-commit hooks and code quality tools (ruff, mypy)
39+
- CONTRIBUTING.md with contribution guidelines
40+
- CHANGELOG.md for tracking changes
41+
- TESTING.md with testing documentation
42+
- SECURITY_IMPROVEMENTS.md documenting security enhancements
43+
- Multiple examples in examples/ directory
44+
- Updated batch_operations.py example with new features
45+
- Comprehensive README with quick start guide
3846

3947
### Security
4048
- SQL injection prevention with table name validation
4149
- Input validation for all parameters
4250
- Custom exception classes for better error handling
4351

44-
## [0.1.0] - 2025-01-XX
52+
### Fixed
53+
- PyPI publishing workflow with tag-based releases
54+
- Changelog extraction in GitHub releases
55+
- Changelog parsing in release notes generation
56+
57+
## [0.1.0] - 2025-09-08
4558

4659
### Added
4760
- Initial release of sqlite-vec-client
@@ -87,34 +100,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
87100
- SQLite 3.41+
88101
- sqlite-vec 0.1.6+
89102

90-
## [0.0.1] - 2025-01-XX (Pre-release)
91-
92-
### Added
93-
- Initial project structure
94-
- Basic SQLiteVecClient implementation
95-
- Proof of concept
96-
97103
---
98104

99105
## Version History
100106

101-
- **0.2.0** - Bulk operations, logging, security improvements, CI/CD
102-
- **0.1.0** - First stable release with comprehensive features and testing
103-
- **0.0.1** - Initial development version
104-
105-
## Upgrade Guide
106-
107-
### From 0.1.x to 0.2.0
108-
109-
No breaking changes. New features:
110-
- Use `update_many()` for bulk updates
111-
- Use `get_all()` for memory-efficient iteration
112-
- Use `transaction()` context manager for atomic operations
113-
- Configure logging via environment variable or programmatically
114-
115-
### From 0.0.x to 0.1.0
116-
117-
No breaking changes. This is the first stable release.
107+
- **1.0.0** - First stable release with comprehensive features, bulk operations, logging, security improvements, and CI/CD
108+
- **0.1.0** - Initial release
118109

119110
---
120111

0 commit comments

Comments
 (0)