Skip to content

Commit f901797

Browse files
committed
📚 DocWeaver updates - 2025-09-25 10:46
1 parent 9be5c07 commit f901797

2 files changed

Lines changed: 32 additions & 7 deletions

File tree

docs/weaviate/config-refs/collections.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -931,13 +931,15 @@ This means that the feature is still under development and may change in future
931931

932932
:::
933933

934-
Collection aliases are alternative names for Weaviate collections that allow you to reference a collection by an alternative name.
934+
Collection aliases are alternative names for Weaviate collections that allow you to reference a collection by multiple names. When you query using an alias, Weaviate automatically routes the request to the target collection.
935935

936-
Weaviate automatically routes alias requests to the target collection. This allows you to use aliases wherever collection names are required. This includes [collection management](../manage-collections/index.mdx), [queries](../search/index.mdx), and all other operations requiring a specific collection name with the **exception** of deleting collections. To delete a collection you need to use its name. Deleting a collection does not automatically delete aliases pointing to it.
936+
Aliases are particularly useful for collection migrations, maintaining stable application interfaces, and managing multiple environments without changing application code.
937+
938+
You can use aliases wherever collection names are required, including [collection management](../manage-collections/index.mdx), [queries](../search/index.mdx), and all other operations requiring a specific collection name with the **exception** of deleting collections. To delete a collection you need to use its name. Deleting a collection does not automatically delete aliases pointing to it.
937939

938940
Alias names must be unique (can't match existing collections or other aliases) and multiple aliases can point to the same collection. You can set up collection aliases [programmatically through client libraries](../manage-collections/collection-aliases.mdx) or by using the <SkipLink href="/weaviate/api/rest#tag/aliases">REST endpoints</SkipLink>.
939941

940-
In order to manage collection aliases, you need to posses the right [`Collection aliases`](../configuration/rbac/index.mdx#available-permissions) permissions. To manage the underlying collection the alias references, you also need the [`Collections`](../configuration/rbac/index.mdx#available-permissions) permissions for that specific collection.
942+
To manage collection aliases, you need the [`Collection aliases`](../configuration/rbac/index.mdx#available-permissions) permissions. To manage the underlying collection that the alias references, you also need the [`Collections`](../configuration/rbac/index.mdx#available-permissions) permissions for that specific collection.
941943

942944
## Further resources
943945

docs/weaviate/starter-guides/managing-collections/index.mdx

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -232,15 +232,32 @@ Sharding settings determine how each collection is sharded and distributed acros
232232

233233
## Collection aliases
234234

235+
### What are collection aliases?
236+
237+
Collection aliases are alternative names (pointers) for Weaviate collections that allow you to reference a collection by multiple names. Think of an alias as a stable reference that can point to different collections over time, similar to how a domain name points to an IP address.
238+
239+
When you query using an alias, Weaviate automatically routes the request to the target collection. This means your application code can reference the stable alias name while the underlying collection can be changed, migrated, or updated without any code changes.
240+
241+
**Example**: If you have a collection named "Articles_v2" and create an alias "Articles" pointing to it, you can query using either name:
242+
- Query "Articles" → routes to "Articles_v2"
243+
- Query "Articles_v2" → directly accesses "Articles_v2"
244+
245+
**Key Benefits:**
246+
- Zero-downtime collection migrations
247+
- Stable application interfaces during schema changes
248+
- Support for multiple environments (dev/staging/prod)
249+
- Easy rollback capabilities
250+
- A/B testing with different collection versions
251+
235252
:::caution Technical preview
236253

237254
Collection aliases were added in **`v1.32`** as a **technical preview**.<br/><br/>
238-
This means that the feature is still under development and may change in future releases, including potential breaking changes.
255+
This means the feature is still under development and may change in future releases, including potential breaking changes. The API and behavior may be modified based on user feedback and testing.
239256
**We do not recommend using this feature in production environments at this time.**
240257

241258
:::
242259

243-
Collection aliases are alternative names (pointers) for Weaviate collections that allow you to reference a collection by multiple names. When you query using an alias, Weaviate automatically routes the request to the target collection. You can set up collection aliases [programmatically through client libraries](../../manage-collections/collection-aliases.mdx) or by using the <SkipLink href="/weaviate/api/rest#tag/aliases">REST endpoints</SkipLink>.
260+
You can set up collection aliases [programmatically through client libraries](../../manage-collections/collection-aliases.mdx) or by using the <SkipLink href="/weaviate/api/rest#tag/aliases">REST endpoints</SkipLink>.
244261

245262
import Tabs from "@theme/Tabs";
246263
import TabItem from "@theme/TabItem";
@@ -252,9 +269,15 @@ import JavaCode from "!!raw-loader!/_includes/code/howto/java/src/test/java/io/w
252269

253270
### Migration workflow with collection aliases
254271

255-
Collection aliases enable collection migrations with zero downtime. Previously, migrating to a new collection required creating the new collection, pausing your application, updating all collection references in your code, then restarting the application, resulting in service interruption.
272+
Collection aliases enable collection migrations with zero downtime, solving a critical operational challenge. Previously, migrating to a new collection required creating the new collection, pausing your application, updating all collection references in your code, then restarting the application, resulting in service interruption and potential data loss.
273+
274+
With aliases, this process becomes seamless: simply create a new collection with your updated collection definition, migrate your data, then instantly [switch the alias](../../manage-collections/collection-aliases.mdx#update-an-alias) to point to the new collection. All your existing queries will continue running uninterrupted because your application code remains unchanged - it references the stable alias name rather than the underlying collection.
256275

257-
Now with aliases, simply create a new collection with your updated collection definition, migrate your data, then instantly [switch the alias](../../manage-collections/collection-aliases.mdx#update-an-alias) to point to the new collection. All your existing queries will continue running uninterrupted. Your application code remains unchanged, as it references the stable alias name rather than the underlying collection.
276+
This approach is particularly valuable for:
277+
- **Schema migrations**: Update collection definitions without downtime
278+
- **Performance optimizations**: Switch to collections with better index configurations
279+
- **Environment management**: Seamlessly promote collections from staging to production
280+
- **Rollback scenarios**: Instantly revert to previous collection versions if issues arise
258281

259282
Here's a complete example showing how to use aliases for a collection migration:
260283

0 commit comments

Comments
 (0)