@podge/sdk-node 0.2.0-beta.4 → 0.2.0-beta.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +38 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,43 @@
|
|
|
1
1
|
# @podge/sdk-node
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
**Find the needle, keep the haystack.** Podge takes data of every shape and size and
|
|
4
|
+
turns it into shippable, performant search for your application — no infrastructure to
|
|
5
|
+
run, no query tuning, no schemas to perfect. Just ingest and search.
|
|
6
|
+
|
|
7
|
+
Highlighting, faceting, and the rest of the polish come standard. Easy for humans and AI
|
|
8
|
+
agents alike.
|
|
9
|
+
|
|
10
|
+
This SDK is the fastest way to wire Podge into a Node.js or TypeScript application.
|
|
11
|
+
|
|
12
|
+
## Core concepts
|
|
13
|
+
|
|
14
|
+
Podge organizes everything into four primitives:
|
|
15
|
+
|
|
16
|
+
- **Workspace** — the top-level container, similar to a project. Everything else lives
|
|
17
|
+
inside it.
|
|
18
|
+
- **Environment** — an isolated context within a workspace. A `dev` environment is
|
|
19
|
+
created for you by default; add more to match each environment where you keep data
|
|
20
|
+
(e.g. `staging`, `production`). Collections and their data are scoped to an environment,
|
|
21
|
+
so you can work in one without affecting another.
|
|
22
|
+
- **Collection** — a group of items that can be searched together. If your application is
|
|
23
|
+
a directory of burritos, you'd create a `burritos` collection.
|
|
24
|
+
- **Item** — an individual searchable record within a collection (a single burrito).
|
|
25
|
+
|
|
26
|
+
### Keeping data in sync
|
|
27
|
+
|
|
28
|
+
Podge is a search index that mirrors your source of truth, so the goal is to keep it in
|
|
29
|
+
step with your application's data. Hook into the changes in your app and push them to
|
|
30
|
+
Podge as they happen:
|
|
31
|
+
|
|
32
|
+
- **Item added** → `podge.createItem()`
|
|
33
|
+
- **Item modified** → `podge.updateItem()`
|
|
34
|
+
- **Item deleted** → `podge.deleteItem()`
|
|
35
|
+
|
|
36
|
+
For data that already exists, use `createImportJob()` to backfill an entire collection
|
|
37
|
+
in one go via a presigned S3 upload — no need to loop through records one at a time.
|
|
38
|
+
|
|
39
|
+
> **Note:** Podge is currently in closed beta and isn't recommended for production use yet.
|
|
40
|
+
> [Create an account](https://dev.podge.dev) to get access.
|
|
4
41
|
|
|
5
42
|
## Installation
|
|
6
43
|
|