Skip to content
This repository was archived by the owner on Dec 10, 2025. It is now read-only.

Commit ca3b2fa

Browse files
committed
add more catalog management commands for 0.11.6.0+
1 parent 31f5202 commit ca3b2fa

File tree

2 files changed

+64
-7
lines changed

2 files changed

+64
-7
lines changed

docs/configuration.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -99,17 +99,14 @@ neodb-manage task --list
9999
neodb-manage cron --list
100100
```
101101

102-
Manage search index
103-
```
104-
neo-manage index --reindex
105-
```
102+
Rebuild search index
106103

107-
Crawl links
108104
```
109-
neodb-manage cat [--save] <url> # parse / save a supported link
110-
neodb-manage crawl <url> # crawl all recognizable links from a page
105+
neodb-manage catalog idx-reindex
111106
```
112107

108+
see `usage/catalog.md` for other commands to manage catalog
109+
113110

114111
## Run PostgresQL/Redis/Typesense without Docker
115112

docs/usage/catalog.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Catalog Management
2+
3+
## Crawl links
4+
5+
```
6+
neodb-manage cat [--save] <url> # parse / save a supported link
7+
neodb-manage crawl <url> # crawl all recognizable links from a page
8+
```
9+
## Data Management
10+
11+
- `neodb-manage catalog integrity`: Check and fix integrity issues for merged and deleted items
12+
- Use `--fix` to automatically fix issues
13+
- Example: `neodb-manage catalog integrity --fix`
14+
15+
- `neodb-manage catalog purge`: Purge deleted items from the database
16+
- Use `--fix` to actually perform the deletion
17+
- Example: `neodb-manage catalog purge --fix`
18+
19+
- `neodb-manage catalog migrate`: Run specified migration scripts
20+
- Requires `--name` to specify which migration to run
21+
- Example: `neodb-manage catalog migrate --name merge_works`
22+
- Available migrations:
23+
- `merge_works`: Merge work items (2025-03-01)
24+
- `fix_deleted_edition`: Fix soft deleted edition items (2025-02-08)
25+
- `fix_bangumi`: Fix Bangumi-related items (2025-04-20)
26+
27+
## Search
28+
29+
- `neodb-manage catalog search`: Search items in the index
30+
- Use `--query` to specify the search query
31+
- Example: `neodb-manage catalog search --query "Harry Potter"`
32+
33+
- `neodb-manage catalog extsearch`: Search external sites
34+
- Use `--query` for search terms and `--category` to filter by category
35+
- Example: `neodb-manage catalog extsearch --query "Inception" --category movie`
36+
37+
## Index Management
38+
39+
- `neodb-manage catalog idx-info`: Show information about the search index
40+
- Example: `neodb-manage catalog idx-info`
41+
42+
- `neodb-manage catalog idx-init`: Check and create the index if it doesn't exist
43+
- Example: `neodb-manage catalog idx-init`
44+
45+
- `neodb-manage catalog idx-destroy`: Delete the entire search index
46+
- Requires confirmation or `--yes` flag
47+
- Example: `neodb-manage catalog idx-destroy --yes`
48+
49+
- `neodb-manage catalog idx-alt`: Update index schema (currently not implemented)
50+
51+
- `neodb-manage catalog idx-delete`: Delete all documents in the index
52+
- Example: `neodb-manage catalog idx-delete`
53+
54+
- `neodb-manage catalog idx-reindex`: Rebuild the search index
55+
- Use `--batch-size` to specify how many items to process at once
56+
- Example: `neodb-manage catalog idx-reindex --batch-size 500`
57+
58+
- `neodb-manage catalog idx-get`: View one document in the index
59+
- Requires `--url` to specify which item to retrieve
60+
- Example: `neodb-manage catalog idx-get --url "https://example.com/item/123"`

0 commit comments

Comments
 (0)