Skip to content

Document a new procedure db.compact #3176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
NataliaIvakina wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Document a new procedure db.compact #3176

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions modules/ROOT/pages/procedures/built-in-procedures.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1021,6 +1021,21 @@ It is therefore not supported by the parallel runtime.
For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/current/planning-and-tuning/runtimes/concepts#runtimes-parallel-runtime[Cypher Manual -> Parallel runtime].
====


[role=label--new-2026.07 label--enterprise-edition label--cypher-25]
[[procedure_db_compact]]
=== db.compact()

.Details
|===
| *Syntax* 3+m| db.compact() :: (numBytesTrimmed :: INTEGER)
| *Description* 3+a| Initiate and wait for a compaction. Mainly native indexes, counts/degrees stores and _.id_ files are compacted. While compaction is running, transaction throughput might temporarily degrade slightly, due to increased IO load.
.2+| *Return arguments* | *Name* | *Type* | *Description*
| `numBytesTrimmed` | `INTEGER` | Number of bytes that compaction trimmed from the database files.
| *Mode* 3+| DBMS
|===


[[procedure_db_info]]
=== db.info()

Expand Down