fix #70 extend the persistence docs to support AOF #71
Conversation
WalkthroughThe changes introduce new documentation files and updates related to FalkorDB's persistence mechanisms, specifically focusing on the support for AOF (Append Only File) and enhancing the overall management documentation. New entries in the wordlist expand the vocabulary relevant to database management. The modifications aim to improve user guidance and understanding of data persistence strategies. Changes
Assessment against linked issues
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
fix page order fix preview branch to main
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (4)
- .wordlist.txt (1 hunks)
- management/index.md (1 hunks)
- management/persistence.md (1 hunks)
- operations/persistence.md (1 hunks)
Files skipped from review due to trivial changes (3)
- .wordlist.txt
- management/index.md
- operations/persistence.md
Additional context used
LanguageTool
management/persistence.md
[style] ~19-~19: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...e representation of your FalkorDB data. RDB files are perfect for backups. For inst...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[typographical] ~19-~19: After the expression ‘for example’ a comma is usually used.
Context: ... RDB files are perfect for backups. For instance you may want to archive your RDB files ...(COMMA_FOR_EXAMPLE)
[style] ~20-~20: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...data set in case of disasters. * RDB is very good for disaster recovery, being a single c...(EN_WEAK_ADJECTIVE)
[uncategorized] ~21-~21: Possible missing comma found.
Context: ...ly encrypted). * RDB maximizes FalkorDB performances since the only work the FalkorDB parent...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~21-~21: Consider a shorter alternative to avoid wordiness.
Context: ...the FalkorDB parent process needs to do in order to persist is forking a child that will do...(IN_ORDER_TO_PREMIUM)
[uncategorized] ~27-~27: Possible missing comma found.
Context: ...oss in case FalkorDB stops working (for example after a power outage). You can configur...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~27-~27: Possible missing comma found.
Context: ...e points* where an RDB is produced (for instance after at least five minutes and 100 wri...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~27-~27: A comma may be missing after the conjunctive/linking adverb ‘However’.
Context: ...et, you can have multiple save points). However you'll usually create an RDB snapshot e...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~27-~27: Possible missing comma found.
Context: ...king without a correct shutdown for any reason you should be prepared to lose the late...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~28-~28: Consider a shorter alternative to avoid wordiness.
Context: ...es of data. * RDB needs to fork() often in order to persist on disk using a child process. ...(IN_ORDER_TO_PREMIUM)
[misspelling] ~28-~28: This word is normally spelled with a hyphen.
Context: ...sk using a child process. fork() can be time consuming if the dataset is big, and may result i...(EN_COMPOUNDS_TIME_CONSUMING)
[style] ~28-~28: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...r even for one second if the dataset is very big and the CPU performance is not great. A...(EN_WEAK_ADJECTIVE)
[uncategorized] ~28-~28: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...also needs to fork() but less frequently and you can tune how often you want to rewr...(COMMA_COMPOUND_SENTENCE)
[style] ~33-~33: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...er reasons) the FalkorDB-check-aof tool is able to fix it easily. * FalkorDB is able to au...(BE_ABLE_TO)
[style] ~34-~34: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...ol is able to fix it easily. * FalkorDB is able to automatically rewrite the AOF in backgr...(BE_ABLE_TO)
[style] ~34-~34: Consider using a different adverb to strengthen your wording.
Context: ...DB continues appending to the old file, a completely new one is produced with the minimal se...(COMPLETELY_ENTIRELY)
[typographical] ~35-~35: After the expression ‘for example’ a comma is usually used.
Context: ...can even easily export an AOF file. For instance even if you've accidentally flushed eve...(COMMA_FOR_EXAMPLE)
[style] ~35-~35: ‘in the meantime’ might be wordy. Consider a shorter alternative.
Context: ... as no rewrite of the log was performed in the meantime, you can still save your data set just ...(EN_WORDINESS_PREMIUM_IN_THE_MEANTIME)
[style] ~40-~40: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...alent RDB files for the same dataset. * AOF can be slower than RDB depending on the...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~40-~40: Possible missing comma found.
Context: ...depending on the exact fsync policy. In general with fsync set to every second perfor...(AI_HYDRA_LEO_MISSING_COMMA)
[formatting] ~40-~40: Consider inserting a comma here, unless the first half is essential to the meaning of the sentence.
Context: ...ance is still very high, and with fsync disabled it should be exactly as fast as RDB eve...(WITH_THAT_COMMA)
[uncategorized] ~40-~40: Possible missing comma found.
Context: ...ly as fast as RDB even under high load. Still RDB is able to provide more guarantees ...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~40-~40: As a shorter alternative for ‘able to’, consider using “can”.
Context: ... as RDB even under high load. Still RDB is able to provide more guarantees about the maxim...(BE_ABLE_TO)
[style] ~53-~53: Consider using an alternative to avoid wordiness and strengthen your wording.
Context: ...ourage it since to have an RDB snapshot from time to time is a great idea for doing database back...(FROM_TIME_TO_TIME)
[uncategorized] ~59-~59: Did you mean: “By default,”?
Context: ...o persistence models. ## Snapshotting By default FalkorDB saves snapshots of the dataset...(BY_DEFAULT_COMMA)
[formatting] ~91-~91: Consider inserting a comma after an introductory phrase for better readability.
Context: ... are use cases for full durability, and in these cases FalkorDB snapshotting alone is not a vi...(IN_THAT_CASE_COMMA)
[uncategorized] ~94-~94: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...e append-only file is an alternative, fully-durable strategy for FalkorDB. You can turn on...(HYPHENATED_LY_ADVERB_ADJECTIVE)
[misspelling] ~105-~105: This word is normally spelled as one.
Context: ... to rebuild the state. FalkorDB uses a multi part AOF mechanism. That is, the original si...(EN_COMPOUNDS_MULTI_PART)
[grammar] ~108-~108: The verb form ‘contains’ does not seem to match the subject ‘files’.
Context: ...(#log-rewriting). The incremental files contains incremental changes since the last base...(SUBJECT_VERB_AGREEMENT_PLURAL)
[style] ~119-~119: Consider using a different adverb to strengthen your wording.
Context: ...DB continues appending to the old file, a completely new one is produced with the minimal se...(COMPLETELY_ENTIRELY)
[style] ~123-~123: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...rDB supports an interesting feature: it is able to rebuild the AOF in the background witho...(BE_ABLE_TO)
[style] ~124-~124: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...write the shortest sequence of commands needed to rebuild the current dataset in memory. ...(REP_NEED_TO_VB)
[style] ~125-~125: This adverb was used twice in the sentence. Consider removing one of them or replacing them with a synonym.
Context: ...ill automatically trigger log rewriting automatically (see the example configuration file for...(ADVERB_REPETITION_PREMIUM)
[style] ~130-~130: Consider a shorter alternative to avoid wordiness.
Context: ...is temporary manifest file take effect. In order to avoid the problem of creating many incr...(IN_ORDER_TO_PREMIUM)
[uncategorized] ~140-~140: Loose punctuation mark.
Context: ...e three options: *appendfsync always:fsyncevery time new commands are app...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~140-~140: Consider adding a comma between these intensifiers.
Context: ...e new commands are appended to the AOF. Very very slow, very safe. Note that the commands...(RB_RB_COMMA)
[uncategorized] ~141-~141: Loose punctuation mark.
Context: ...g the replies). *appendfsync everysec:fsyncevery second. Fast enough and y...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~141-~141: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ysec:fsync` every second. Fast enough and you may lose 1 second of data if there ...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~142-~142: Loose punctuation mark.
Context: ... there is a disaster. *appendfsync no: Neverfsync, just put your data in th...(UNLIKELY_OPENING_PUNCTUATION)
[typographical] ~142-~142: Consider adding a comma after ‘Normally’ for more clarity.
Context: ...ystem. The faster and less safe method. Normally Linux will flush data every 30 seconds ...(RB_LY_COMMA)
[uncategorized] ~152-~152: Possible missing comma found.
Context: ... full at the time of writing. When this happens the AOF still contains consistent data ...(AI_HYDRA_LEO_MISSING_COMMA)
[misspelling] ~157-~157: This word is normally spelled with a hyphen.
Context: ...OF anyway, just discarding the last non well formed command in the file. In this case the s...(EN_COMPOUNDS_WELL_FORMED)
[formatting] ~157-~157: Consider inserting a comma after an introductory phrase for better readability.
Context: ...st non well formed command in the file. In this case the server will emit a log like the fol...(IN_THAT_CASE_COMMA)
[style] ~169-~169: This phrasing can be overused. Try elevating your writing with a more formal alternative.
Context: ...to force FalkorDB to stop in such cases if you want, but the default configuration is to co...(IF_YOU_WANT)
[style] ~170-~170: Consider a shorter alternative to avoid wordiness.
Context: ...command in the file is not well-formed, in order to guarantee availability after a restart....(IN_ORDER_TO_PREMIUM)
[uncategorized] ~180-~180: Possible missing comma found.
Context: ... FalkorDB-check-aof --fix * Optionally usediff -uto check what is the diff...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~197-~197: As an alternative to the over-used intensifier ‘quite’, consider replacing this phrase.
Context: ... format of the FalkorDB protocol and is quite simple to fix manually. Otherwise it is possib...(EN_WEAK_ADJECTIVE)
[uncategorized] ~198-~198: A comma may be missing after the conjunctive/linking adverb ‘Otherwise’.
Context: ...ol and is quite simple to fix manually. Otherwise it is possible to let the utility fix t...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[formatting] ~198-~198: Consider inserting a comma after an introductory phrase for better readability.
Context: ...et the utility fix the file for us, but in that case all the AOF portion from the invalid pa...(IN_THAT_CASE_COMMA)
[misspelling] ~208-~208: This word is normally spelled as one.
Context: ...ing. This is how it works: FalkorDB multi-part AOF * FalkorDB [forks](https://linux...(EN_COMPOUNDS_MULTI_PART)
[grammar] ~215-~215: The plural noun “increments” cannot be used with the article “a”. Did you mean “a new increment” or “new increments”?
Context: ...n a temporary file. * The parent opens a new increments AOF file to continue writing updates. ...(A_NNS)
[grammar] ~225-~225: The word order is incorrect here.
Context: ...le and any unused increment files. ### How I can switch to AOF, if I'm currently using d...(HOW_THIS_CANT)
[uncategorized] ~262-~262: Possible missing comma found.
Context: ...DB persistence are enabled and FalkorDB restarts the AOF file will be used to reconstruc...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~268-~268: The word “Backup” is a noun. The verb is spelled with a white space.
Context: ... the following sentence: Make Sure to Backup Your Database. Disks break, instances...(NOUN_VERB_CONFUSION)
[grammar] ~268-~268: “backups” is a plural noun. It appears that the verb form is incorrect.
Context: ...oud disappear, and so forth: no backups means huge risk of data disappearing into /de...(PCT_PLURAL_NOUN_SINGULAR_VERB_AGREEMENT)
[uncategorized] ~278-~278: Possible missing comma found.
Context: ...e suggest: * Create a cron job in your server creating hourly snapshots of the RDB fi...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~279-~279: Possible missing comma found.
Context: ...sure too old snapshots are deleted: for instance you can take hourly snapshots for the l...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~280-~280: Possible missing comma found.
Context: ... information. * At least one time every day make sure to transfer an RDB snapshot *...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~286-~286: Possible missing comma found.
Context: ...nddirname` configuration. During normal operation all you need to do is copy/tar the file...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~302-~302: This phrase is redundant. Consider writing “point” or “time”.
Context: ...ntent should be consistent at any given point in time. Note: If you want to handle the ...(MOMENT_IN_TIME)
[uncategorized] ~305-~305: Possible missing comma found.
Context: ...rite will automatically start after the restart you can change step 1 above to also per...(AI_HYDRA_LEO_MISSING_COMMA)
[misspelling] ~320-~320: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...om you, install ssh there, and generate a ssh client key without passphrase, then...(EN_A_VS_AN)
[style] ~324-~324: This phrase is redundant. Consider writing “sure”.
Context: ...mented in the right way. At least, make absolutely sure that after the transfer is completed yo...(ABSOLUTELY_SURE)
[style] ~325-~325: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...hat after the transfer is completed you are able to verify the file size (that should match...(BE_ABLE_TO)
[misspelling] ~325-~325: Make sure that ‘the one of’ is correct and that ‘one’ is a pronoun. Possibly, the ‘the’ is unnecessary or ‘of’ is better expressed with a preposition such as ‘about’ or ‘in’.
Context: ...verify the file size (that should match the one of the file you copied) and possibly the S...(THE_ONE_OF_DT)
[typographical] ~326-~326: Usually, there’s no comma before “if”.
Context: ...you copied) and possibly the SHA1 digest, if you are using a VPS. You also need som...(IF_NO_COMMA)
Markdownlint
management/persistence.md
43-43: Expected: atx; Actual: setext
Heading style(MD003, heading-style)
178-178: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
208-208: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
160-160: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
189-189: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
160-160: Expected: indented; Actual: fenced
Code block style(MD046, code-block-style)
189-189: Expected: indented; Actual: fenced
Code block style(MD046, code-block-style)
70-70: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
70-70: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
94-94: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
94-94: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
Additional comments not posted (11)
management/persistence.md (11)
1-6: Header and Metadata ReviewThe YAML front matter is correctly formatted and provides essential metadata about the document. This includes the title, navigation order, description, and parent category. The description succinctly captures the essence of the document's content.
8-14: Introduction to Persistence OptionsThe introduction clearly outlines the different types of persistence supported by FalkorDB, including RDB, AOF, No persistence, and a combination of RDB and AOF. This section is crucial as it sets the context for the rest of the document.
17-24: Advantages of RDBThe advantages of RDB are well-explained, highlighting its suitability for backups, disaster recovery, performance, and support for partial resynchronizations. The explanations are clear and provide a good understanding of when RDB might be the preferred persistence option.
Tools
LanguageTool
[style] ~19-~19: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...e representation of your FalkorDB data. RDB files are perfect for backups. For inst...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[typographical] ~19-~19: After the expression ‘for example’ a comma is usually used.
Context: ... RDB files are perfect for backups. For instance you may want to archive your RDB files ...(COMMA_FOR_EXAMPLE)
[style] ~20-~20: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...data set in case of disasters. * RDB is very good for disaster recovery, being a single c...(EN_WEAK_ADJECTIVE)
[uncategorized] ~21-~21: Possible missing comma found.
Context: ...ly encrypted). * RDB maximizes FalkorDB performances since the only work the FalkorDB parent...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~21-~21: Consider a shorter alternative to avoid wordiness.
Context: ...the FalkorDB parent process needs to do in order to persist is forking a child that will do...(IN_ORDER_TO_PREMIUM)
25-29: Disadvantages of RDBThis section effectively outlines the limitations of RDB, particularly in scenarios where minimizing data loss is critical. The mention of the operational overhead of using
fork()provides a realistic view of potential performance impacts.Tools
LanguageTool
[uncategorized] ~27-~27: Possible missing comma found.
Context: ...oss in case FalkorDB stops working (for example after a power outage). You can configur...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~27-~27: Possible missing comma found.
Context: ...e points* where an RDB is produced (for instance after at least five minutes and 100 wri...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~27-~27: A comma may be missing after the conjunctive/linking adverb ‘However’.
Context: ...et, you can have multiple save points). However you'll usually create an RDB snapshot e...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~27-~27: Possible missing comma found.
Context: ...king without a correct shutdown for any reason you should be prepared to lose the late...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~28-~28: Consider a shorter alternative to avoid wordiness.
Context: ...es of data. * RDB needs to fork() often in order to persist on disk using a child process. ...(IN_ORDER_TO_PREMIUM)
[misspelling] ~28-~28: This word is normally spelled with a hyphen.
Context: ...sk using a child process. fork() can be time consuming if the dataset is big, and may result i...(EN_COMPOUNDS_TIME_CONSUMING)
[style] ~28-~28: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...r even for one second if the dataset is very big and the CPU performance is not great. A...(EN_WEAK_ADJECTIVE)
[uncategorized] ~28-~28: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...also needs to fork() but less frequently and you can tune how often you want to rewr...(COMMA_COMPOUND_SENTENCE)
30-36: Advantages of AOFThe advantages of AOF are detailed, emphasizing durability, reliability during power outages, and the ability to automatically rewrite logs to optimize space. This section aligns well with the PR's objectives to enhance AOF support.
Tools
LanguageTool
[style] ~33-~33: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...er reasons) the FalkorDB-check-aof tool is able to fix it easily. * FalkorDB is able to au...(BE_ABLE_TO)
[style] ~34-~34: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...ol is able to fix it easily. * FalkorDB is able to automatically rewrite the AOF in backgr...(BE_ABLE_TO)
[style] ~34-~34: Consider using a different adverb to strengthen your wording.
Context: ...DB continues appending to the old file, a completely new one is produced with the minimal se...(COMPLETELY_ENTIRELY)
[typographical] ~35-~35: After the expression ‘for example’ a comma is usually used.
Context: ...can even easily export an AOF file. For instance even if you've accidentally flushed eve...(COMMA_FOR_EXAMPLE)
[style] ~35-~35: ‘in the meantime’ might be wordy. Consider a shorter alternative.
Context: ... as no rewrite of the log was performed in the meantime, you can still save your data set just ...(EN_WORDINESS_PREMIUM_IN_THE_MEANTIME)
37-41: Disadvantages of AOFThe disadvantages section for AOF is concise and informative, discussing the potential for larger file sizes and performance variations based on fsync policies. This balanced view helps users make informed decisions about using AOF.
Tools
LanguageTool
[style] ~40-~40: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...alent RDB files for the same dataset. * AOF can be slower than RDB depending on the...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~40-~40: Possible missing comma found.
Context: ...depending on the exact fsync policy. In general with fsync set to every second perfor...(AI_HYDRA_LEO_MISSING_COMMA)
[formatting] ~40-~40: Consider inserting a comma here, unless the first half is essential to the meaning of the sentence.
Context: ...ance is still very high, and with fsync disabled it should be exactly as fast as RDB eve...(WITH_THAT_COMMA)
[uncategorized] ~40-~40: Possible missing comma found.
Context: ...ly as fast as RDB even under high load. Still RDB is able to provide more guarantees ...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~40-~40: As a shorter alternative for ‘able to’, consider using “can”.
Context: ... as RDB even under high load. Still RDB is able to provide more guarantees about the maxim...(BE_ABLE_TO)
43-55: General Recommendations on Persistence UsageThis section provides practical advice on choosing between RDB and AOF, or using both, depending on the user's data safety requirements. The guidance is clear and pragmatic, making it a valuable read for users deciding on their persistence strategy.
Tools
LanguageTool
[style] ~53-~53: Consider using an alternative to avoid wordiness and strengthen your wording.
Context: ...ourage it since to have an RDB snapshot from time to time is a great idea for doing database back...(FROM_TIME_TO_TIME)
Markdownlint
43-43: Expected: atx; Actual: setext
Heading style(MD003, heading-style)
58-71: Snapshotting DetailsThe snapshotting section describes the operational details of how RDB snapshots are created and managed. The use of
fork()and the benefits of copy-on-write semantics are well-explained, providing a deep dive into the mechanics behind RDB.Tools
LanguageTool
[uncategorized] ~59-~59: Did you mean: “By default,”?
Context: ...o persistence models. ## Snapshotting By default FalkorDB saves snapshots of the dataset...(BY_DEFAULT_COMMA)
Markdownlint
70-70: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
70-70: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
86-109: Append-Only File Mechanism and Log RewritingThis section is critical as it directly relates to the PR's objective of extending AOF support. It thoroughly explains the AOF mechanism, including configuration options, log rewriting, and the handling of AOF files during server operations. The detail provided here will greatly assist users in understanding and implementing AOF in their setups.
Tools
LanguageTool
[formatting] ~91-~91: Consider inserting a comma after an introductory phrase for better readability.
Context: ... are use cases for full durability, and in these cases FalkorDB snapshotting alone is not a vi...(IN_THAT_CASE_COMMA)
[uncategorized] ~94-~94: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...e append-only file is an alternative, fully-durable strategy for FalkorDB. You can turn on...(HYPHENATED_LY_ADVERB_ADJECTIVE)
[misspelling] ~105-~105: This word is normally spelled as one.
Context: ... to rebuild the state. FalkorDB uses a multi part AOF mechanism. That is, the original si...(EN_COMPOUNDS_MULTI_PART)
[grammar] ~108-~108: The verb form ‘contains’ does not seem to match the subject ‘files’.
Context: ...(#log-rewriting). The incremental files contains incremental changes since the last base...(SUBJECT_VERB_AGREEMENT_PLURAL)
Markdownlint
94-94: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
94-94: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
250-265: Interactions Between AOF and RDB PersistenceThe explanation of how FalkorDB manages interactions between AOF and RDB during operations like snapshotting and log rewriting is crucial for understanding potential resource contention and ensuring system stability. This section is well-crafted and informative.
Tools
LanguageTool
[uncategorized] ~262-~262: Possible missing comma found.
Context: ...DB persistence are enabled and FalkorDB restarts the AOF file will be used to reconstruc...(AI_HYDRA_LEO_MISSING_COMMA)
266-330: Backup and Disaster Recovery StrategiesThe comprehensive coverage of backup and disaster recovery strategies, including practical steps and configurations, provides invaluable guidance for users. The emphasis on ensuring data safety through various means, including external transfers and the use of services like Amazon S3, is particularly noteworthy.
Tools
LanguageTool
[grammar] ~268-~268: The word “Backup” is a noun. The verb is spelled with a white space.
Context: ... the following sentence: Make Sure to Backup Your Database. Disks break, instances...(NOUN_VERB_CONFUSION)
[grammar] ~268-~268: “backups” is a plural noun. It appears that the verb form is incorrect.
Context: ...oud disappear, and so forth: no backups means huge risk of data disappearing into /de...(PCT_PLURAL_NOUN_SINGULAR_VERB_AGREEMENT)
[uncategorized] ~278-~278: Possible missing comma found.
Context: ...e suggest: * Create a cron job in your server creating hourly snapshots of the RDB fi...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~279-~279: Possible missing comma found.
Context: ...sure too old snapshots are deleted: for instance you can take hourly snapshots for the l...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~280-~280: Possible missing comma found.
Context: ... information. * At least one time every day make sure to transfer an RDB snapshot *...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~286-~286: Possible missing comma found.
Context: ...nddirname` configuration. During normal operation all you need to do is copy/tar the file...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~302-~302: This phrase is redundant. Consider writing “point” or “time”.
Context: ...ntent should be consistent at any given point in time. Note: If you want to handle the ...(MOMENT_IN_TIME)
[uncategorized] ~305-~305: Possible missing comma found.
Context: ...rite will automatically start after the restart you can change step 1 above to also per...(AI_HYDRA_LEO_MISSING_COMMA)
[misspelling] ~320-~320: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...om you, install ssh there, and generate a ssh client key without passphrase, then...(EN_A_VS_AN)
[style] ~324-~324: This phrase is redundant. Consider writing “sure”.
Context: ...mented in the right way. At least, make absolutely sure that after the transfer is completed yo...(ABSOLUTELY_SURE)
[style] ~325-~325: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...hat after the transfer is completed you are able to verify the file size (that should match...(BE_ABLE_TO)
[misspelling] ~325-~325: Make sure that ‘the one of’ is correct and that ‘one’ is a pronoun. Possibly, the ‘the’ is unnecessary or ‘of’ is better expressed with a preposition such as ‘about’ or ‘in’.
Context: ...verify the file size (that should match the one of the file you copied) and possibly the S...(THE_ONE_OF_DT)
[typographical] ~326-~326: Usually, there’s no comma before “if”.
Context: ...you copied) and possibly the SHA1 digest, if you are using a VPS. You also need som...(IF_NO_COMMA)
gkorland
changed the title
| Persistence refers to the writing of data to durable storage, such as a solid-state disk (SSD). FalkorDB provides a range of persistence options. These include: | ||
|
|
||
| * **RDB** (FalkorDB Database): RDB persistence performs point-in-time snapshots of your dataset at specified intervals. | ||
| * **AOF** (Append Only File): AOF persistence logs every write operation received by the server. These operations can then be replayed again at server startup, reconstructing the original dataset. Commands are logged using the same format as the FalkorDB protocol itself. |
There was a problem hiding this comment.
"Commands are logged using the same format as the FalkorDB protocol itself."
Not sure what's the value of stating this, moreover this is not necessarily true, in case a query is replicated / persisted using EFFECTS.
|
|
||
| * **RDB** (FalkorDB Database): RDB persistence performs point-in-time snapshots of your dataset at specified intervals. | ||
| * **AOF** (Append Only File): AOF persistence logs every write operation received by the server. These operations can then be replayed again at server startup, reconstructing the original dataset. Commands are logged using the same format as the FalkorDB protocol itself. | ||
| * **No persistence**: You can disable persistence completely. This is sometimes used when caching. |
There was a problem hiding this comment.
I think this gos without saying.
Someone who's reading this paragraph is most likely interested in persistency.
|
|
||
| ## RDB advantages | ||
|
|
||
| * RDB is a very compact single-file point-in-time representation of your FalkorDB data. RDB files are perfect for backups. For instance you may want to archive your RDB files every hour for the latest 24 hours, and to save an RDB snapshot every day for 30 days. This allows you to easily restore different versions of the data set in case of disasters. |
There was a problem hiding this comment.
No need to get into the archive strategy, just explain that snapshotting can be scheduled.
| ## RDB advantages | ||
|
|
||
| * RDB is a very compact single-file point-in-time representation of your FalkorDB data. RDB files are perfect for backups. For instance you may want to archive your RDB files every hour for the latest 24 hours, and to save an RDB snapshot every day for 30 days. This allows you to easily restore different versions of the data set in case of disasters. | ||
| * RDB is very good for disaster recovery, being a single compact file that can be transferred to far data centers, or onto Amazon S3 (possibly encrypted). |
There was a problem hiding this comment.
Drop the word "far", wouldn't mention S3, RDB being a file can be stored wherever the user likes.
|
|
||
| * RDB is a very compact single-file point-in-time representation of your FalkorDB data. RDB files are perfect for backups. For instance you may want to archive your RDB files every hour for the latest 24 hours, and to save an RDB snapshot every day for 30 days. This allows you to easily restore different versions of the data set in case of disasters. | ||
| * RDB is very good for disaster recovery, being a single compact file that can be transferred to far data centers, or onto Amazon S3 (possibly encrypted). | ||
| * RDB maximizes FalkorDB performances since the only work the FalkorDB parent process needs to do in order to persist is forking a child that will do all the rest. The parent process will never perform disk I/O or alike. |
There was a problem hiding this comment.
Not sure if we need to get too technical here, we could say taking a snapshot doesn't effects the DB performance as it's done on a separated process.
| Older versions of FalkorDB may not recover, and may require the following steps: | ||
|
|
||
| * Make a backup copy of your AOF file. | ||
| * Fix the original file using the `FalkorDB-check-aof` tool that ships with FalkorDB: |
| file may be discarded, leading to a massive amount of data loss if the | ||
| corruption happened to be in the initial part of the file. | ||
|
|
||
| ### How it works |
There was a problem hiding this comment.
this section is out of place
| Log rewriting uses the same copy-on-write trick already in use for | ||
| snapshotting. This is how it works: | ||
|
|
||
| **FalkorDB multi-part AOF** |
|
|
||
| * Profit! Now FalkorDB does an atomic exchange of the manifest files so that the result of this AOF rewrite takes effect. FalkorDB also cleans up the old base file and any unused increment files. | ||
|
|
||
| ### How I can switch to AOF, if I'm currently using dump.rdb snapshots? |
|
|
||
| ## Backing up FalkorDB data | ||
|
|
||
| Before starting this section, make sure to read the following sentence: **Make Sure to Backup Your Database**. Disks break, instances in the cloud disappear, and so forth: no backups means huge risk of data disappearing into /dev/null. |
There was a problem hiding this comment.
Please rephrase: "Before starting this section, make sure to read the following sentence: Make Sure to Backup Your Database."
fix #70
Summary by CodeRabbit
New Features
Documentation