.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "LEI-STORE-FORMAT 5" .TH LEI-STORE-FORMAT 5 "1993-10-02" "public-inbox.git" "public-inbox user manual" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" lei\-store\-format \- lei/store format description .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\f(CW\*(C`lei/store\*(C'\fR is a hybrid store based on \fBpublic\-inbox\-extindex\-format\fR\|(5) (\*(L"extindex\*(R") combined with \fBpublic\-inbox\-v2\-format\fR\|(5) (\*(L"v2\*(R") for blob storage. While v2 is ideal for archiving a single public mailing list; it was never intended for personal mail nor storing multiple blobs of the \*(L"same\*(R" message. .PP As with extindex, it can index disparate \f(CW\*(C`List\-Id\*(C'\fR headers belonging to the \*(L"same\*(R" message with different git blob OIDs. Unlike v2 and extindex, \f(CW\*(C`Message\-ID\*(C'\fR headers are \s-1NOT\s0 required; allowing unsent draft messages to be stored and indexed. .SH "DIRECTORY LAYOUT" .IX Header "DIRECTORY LAYOUT" Blob storage exists in the form of v2\-style epochs. These epochs are under the \f(CW\*(C`local/\*(C'\fR directory (instead of \f(CW\*(C`git/\*(C'\fR) to prevent them from being accidentally treated as a v2 inbox. .SS "\s-1INDEX OVERVIEW AND DEFINITIONS\s0" .IX Subsection "INDEX OVERVIEW AND DEFINITIONS" .Vb 3 \& $EPOCH \- Integer starting with 0 based on time \& $SCHEMA_VERSION \- DB schema version (for Xapian) \& $SHARD \- Integer starting with 0 based on parallelism \& \& ~/.local/share/lei/store \& \- local/$EPOCH.git # normal bare git repositories \& \- mail_sync.sqlite3 # sync state IMAP, Maildir, NNTP .Ve .PP Additionally, the following share the same roles they do in extindex: .PP .Vb 5 \& \- ei.lock # lock file to protect global state \& \- ALL.git # empty, alternates for local/*.git \& \- ei$SCHEMA_VERSION/$SHARD # per\-shard Xapian DB \& \- ei$SCHEMA_VERSION/over.sqlite3 # overview DB for WWW, IMAP \& \- ei$SCHEMA_VERSION/misc # misc Xapian DB .Ve .SS "\s-1XREF3 DEDUPLICATION\s0" .IX Subsection "XREF3 DEDUPLICATION" Index deduplication follows extindex, see \&\*(L"\s-1XREF3 DEDUPLICATION\*(R"\s0 in \fBpublic\-inbox\-extindex\-format\fR\|(5) for more information. .SS "\s-1BLOB DEDUPLICATION\s0" .IX Subsection "BLOB DEDUPLICATION" The contents of \f(CW\*(C`local/*.git\*(C'\fR repos is deduplicated by git blob object IDs (currently \s-1SHA\-1\s0). This allows multiple copies of cross-posted and personally Cc-ed messages to be stored with different \f(CW\*(C`Received:\*(C'\fR, \f(CW\*(C`X\-Spam\-Status:\*(C'\fR and similar headers to allow troubleshooting. .SS "\s-1VOLATILE METADATA\s0" .IX Subsection "VOLATILE METADATA" Keywords and label information (as described in \s-1RFC 8621\s0 for \s-1JMAP\s0) is stored in existing Xapian shards (\f(CW\*(C`ei$SCHEMA_VERSION/$SHARD\*(C'\fR). It is possible to search for messages matching labels and keywords using \f(CW\*(C`L:\*(C'\fR and \f(CW\*(C`kw:\*(C'\fR, respectively. As with all data stored in Xapian indices, volatile metadata is associated with the Xapian document, thus it is shared across different blobs of the \*(L"same\*(R" message. .SS "mail_sync.sqlite3" .IX Subsection "mail_sync.sqlite3" This SQLite database maintained for bidirectional mapping of git blobs to \s-1IMAP\s0 UIDs, Maildir file names, and \s-1NNTP\s0 article numbers. .PP It is also used for retrieving messages from Maildirs indexed by \&\fBlei\-index\fR\|(1). .SH "IPC" .IX Header "IPC" \&\fBlei\-daemon\fR\|(8) communicates with the \f(CW\*(C`lei/store\*(C'\fR process using \&\fBunix\fR\|(7) \f(CW\*(C`SOCK_SEQPACKET\*(C'\fR sockets. .SH "CAVEATS" .IX Header "CAVEATS" Reindexing and synchronization is not yet supported. .SH "THANKS" .IX Header "THANKS" Thanks to the Linux Foundation for sponsoring the development and testing. .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2021 all contributors .PP License: \s-1AGPL\-3.0+\s0 .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBpublic\-inbox\-v2\-format\fR\|(5), \fBpublic\-inbox\-extindex\fR\|(5)