You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: make server-side batching the default import method
Restructure the batch-import guide so server-side (automatic) batching is the
first and recommended way to import data, instead of a separate feature section:
- Lead with server-side batching; present client-side batching as "Manual
batching", the alternative for manual control or for the Go client.
- The Go tab points to manual batching (the Go client has no server-side
batching API) instead of "coming soon".
- Note that server-side batching uses the gRPC API (enabled by default).
- concepts/data-import.mdx: correct the now-stale "only the Python client
supports server-side batch imports" (now Python, TypeScript, Java, and C#;
Go does not yet), and fix a broken sentence.
Copy file name to clipboardExpand all lines: docs/weaviate/concepts/data-import.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ Weaviate offers two flexible methods for importing data in bulk: **client-side b
19
19
20
20
:::tip
21
21
22
-
For **code examples**, check out the [How-to: Batch import](../manage-objects/import.mdx) guide. Currently, only the Pythonclient supports server-side batch imports.
22
+
For **code examples**, check out the [How-to: Batch import](../manage-objects/import.mdx) guide. Server-side batch imports are supported by the Python, TypeScript, Java, and C# clients. The Go client does not yet support them; use client-side batching instead.
23
23
24
24
:::
25
25
@@ -40,7 +40,7 @@ Weaviate's server-side batching, also known as **automatic batching**, aims to p
[Batch imports](../tutorials/import.mdx) are an efficient way to add multiple data objects and cross-references.
20
+
[Batch imports](../tutorials/import.mdx) are an efficient way to add multiple data objects and cross-references. For most use cases, we recommend **server-side batching** as the starting point: the server tells the client how much data to send next, so you don't have to tune batch parameters yourself. When you need manual control over the batch size and concurrency — or you are using a client that does not yet support server-side batching — use [manual batching](#manual-batching) instead.
With [server-side batch imports](../concepts/data-import.mdx#server-side-batching) (also called "automatic" batching), the client sends data in batch sizes determined by feedback from the server. This simplifies your code and helps the server manage its own load. The following example adds objects to a collection named `MyCollection`.
34
29
35
-
The following example adds objects to the`MyCollection` collection.
30
+
Server-side batching uses the [gRPC API](#use-the-grpc-api), which current client versions enable by default.
Use manual (client-side) batching when you want to control the batch size and concurrency yourself, or when using a client that does not yet support server-side batching (such as the Go client). The following example adds objects to the `MyCollection` collection.
94
75
95
-
<SsbStatus/>
76
+
<details>
77
+
<summary>Additional information</summary>
78
+
79
+
To create a bulk import job manually, follow these steps:
80
+
81
+
1. Initialize a batch object.
82
+
1. Add items to the batch object.
83
+
1. Ensure that the last batch is sent (flushed).
96
84
97
-
Here's how to import objects into a collection named `MyCollection` using [server-side batch imports](../concepts/data-import.mdx#server-side-batching). The client will send data in batch sizes using feedback from the server.
@@ -171,7 +171,7 @@ The Java client v6 uses gRPC by default.
171
171
172
172
To use the gRPC API with the Go client, add the `GrpcConfig` field to your client connection code. Update `Secured` if you use an encrypted connection.<br/><br/>
0 commit comments