docs: create MIGRATION.md with migration guide for deprecated APIs (closes #68)#167
Merged
Conversation
…loses #68) - Add MIGRATION.md at project root covering: - Index Creation migration (createHnswIndex etc. -> createIndex + ZVecIndexParams) - Statistics migration (stats() -> getStatsStruct()) - Schema Introspection (new getFieldSchema() API) - Collection Options (ZVecCollectionOptions with createWith/openWith) - Query Object Pattern (ZVecVectorQuery + queryVector()) - Reranker in Queries (queryWithReranker()) - Deprecated Schema Methods (addField* -> add*) - Add 'Upgrading from v0.4.x' section to README.md linking to MIGRATION.md - Add CHANGELOG.md entry for DOC-009
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #68 (DOC-009: Missing Migration Guide for Deprecated APIs).
Creates
MIGRATION.mdas a comprehensive migration guide from v0.4.x deprecated APIs to v0.5.0 modern APIs.Changes
New file:
MIGRATION.mdMigration guide covering 7 sections, each with BEFORE/AFTER code blocks:
createHnswIndex(),createFlatIndex(),createIvfIndex(),createHnswRabitqIndex()→createIndex()+ZVecIndexParamsstats()JSON parsing → typedgetStatsStruct()getFieldSchema()returningZVecFieldSchemacreate()params →ZVecCollectionOptionswithcreateWith()/openWith()query()args →ZVecVectorQuerybuilder withqueryVector()query()→ `queryWithReranker()`addField*()→add*()Modified:
README.mdAdded "Upgrading from v0.4.x" section linking to
MIGRATION.md.Modified:
CHANGELOG.mdAdded entry under
[Unreleased] Addedfor DOC-009.Verification
php -lpasses on all PHP files (no syntax errors)