mirror of https://github.com/apache/cassandra
Add initial in-tree documentation (very incomplete so far)
patch by Stefania, jjirsa, rspitzer & slebresne; reviewed by slebresne for CASSANDRA-8700
This commit is contained in:
Sylvain Lebresne
parent
719e7d6624
commit
cad277be41
13
build.xml
13
build.xml
|
|
@ -67,6 +67,8 @@
|
|||
<property name="test.microbench.src" value="${test.dir}/microbench"/>
|
||||
<property name="dist.dir" value="${build.dir}/dist"/>
|
||||
<property name="tmp.dir" value="${java.io.tmpdir}"/>
|
||||
|
||||
<property name="doc.dir" value="${basedir}/doc"/>
|
||||
|
||||
<property name="source.version" value="1.8"/>
|
||||
<property name="target.version" value="1.8"/>
|
||||
|
|
@ -249,6 +251,17 @@
|
|||
</wikitext-to-html>
|
||||
</target>
|
||||
|
||||
<target name="gen-doc" depends="maven-ant-tasks-init" description="Generate documentation">
|
||||
<exec executable="make" osfamily="unix" dir="${doc.dir}">
|
||||
<arg value="html"/>
|
||||
</exec>
|
||||
<exec executable="cmd" osfamily="dos" dir="${doc.dir}">
|
||||
<arg value="/c"/>
|
||||
<arg value="make.bat"/>
|
||||
<arg value="html"/>
|
||||
</exec>
|
||||
</target>
|
||||
|
||||
<!--
|
||||
Generates Java sources for tokenization support from jflex
|
||||
grammar files
|
||||
|
|
|
|||
|
|
@ -0,0 +1,225 @@
|
|||
# Makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line.
|
||||
SPHINXOPTS =
|
||||
SPHINXBUILD = sphinx-build
|
||||
PAPER =
|
||||
BUILDDIR = build
|
||||
|
||||
# Internal variables.
|
||||
PAPEROPT_a4 = -D latex_paper_size=a4
|
||||
PAPEROPT_letter = -D latex_paper_size=letter
|
||||
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
|
||||
# the i18n builder cannot share the environment and doctrees with the others
|
||||
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
|
||||
|
||||
.PHONY: help
|
||||
help:
|
||||
@echo "Please use \`make <target>' where <target> is one of"
|
||||
@echo " html to make standalone HTML files"
|
||||
@echo " dirhtml to make HTML files named index.html in directories"
|
||||
@echo " singlehtml to make a single large HTML file"
|
||||
@echo " pickle to make pickle files"
|
||||
@echo " json to make JSON files"
|
||||
@echo " htmlhelp to make HTML files and a HTML help project"
|
||||
@echo " qthelp to make HTML files and a qthelp project"
|
||||
@echo " applehelp to make an Apple Help Book"
|
||||
@echo " devhelp to make HTML files and a Devhelp project"
|
||||
@echo " epub to make an epub"
|
||||
@echo " epub3 to make an epub3"
|
||||
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
||||
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
||||
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
|
||||
@echo " text to make text files"
|
||||
@echo " man to make manual pages"
|
||||
@echo " texinfo to make Texinfo files"
|
||||
@echo " info to make Texinfo files and run them through makeinfo"
|
||||
@echo " gettext to make PO message catalogs"
|
||||
@echo " changes to make an overview of all changed/added/deprecated items"
|
||||
@echo " xml to make Docutils-native XML files"
|
||||
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
|
||||
@echo " linkcheck to check all external links for integrity"
|
||||
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
||||
@echo " coverage to run coverage check of the documentation (if enabled)"
|
||||
@echo " dummy to check syntax errors of document sources"
|
||||
|
||||
.PHONY: clean
|
||||
clean:
|
||||
rm -rf $(BUILDDIR)/*
|
||||
|
||||
.PHONY: html
|
||||
html:
|
||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||||
|
||||
.PHONY: dirhtml
|
||||
dirhtml:
|
||||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
||||
|
||||
.PHONY: singlehtml
|
||||
singlehtml:
|
||||
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
||||
|
||||
.PHONY: pickle
|
||||
pickle:
|
||||
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
||||
@echo
|
||||
@echo "Build finished; now you can process the pickle files."
|
||||
|
||||
.PHONY: json
|
||||
json:
|
||||
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
||||
@echo
|
||||
@echo "Build finished; now you can process the JSON files."
|
||||
|
||||
.PHONY: htmlhelp
|
||||
htmlhelp:
|
||||
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
||||
".hhp project file in $(BUILDDIR)/htmlhelp."
|
||||
|
||||
.PHONY: qthelp
|
||||
qthelp:
|
||||
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
||||
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
||||
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ApacheCassandraDocumentation.qhcp"
|
||||
@echo "To view the help file:"
|
||||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ApacheCassandraDocumentation.qhc"
|
||||
|
||||
.PHONY: applehelp
|
||||
applehelp:
|
||||
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
|
||||
@echo
|
||||
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
|
||||
@echo "N.B. You won't be able to view it unless you put it in" \
|
||||
"~/Library/Documentation/Help or install it in your application" \
|
||||
"bundle."
|
||||
|
||||
.PHONY: devhelp
|
||||
devhelp:
|
||||
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
||||
@echo
|
||||
@echo "Build finished."
|
||||
@echo "To view the help file:"
|
||||
@echo "# mkdir -p $$HOME/.local/share/devhelp/ApacheCassandraDocumentation"
|
||||
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ApacheCassandraDocumentation"
|
||||
@echo "# devhelp"
|
||||
|
||||
.PHONY: epub
|
||||
epub:
|
||||
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
||||
@echo
|
||||
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
||||
|
||||
.PHONY: epub3
|
||||
epub3:
|
||||
$(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
|
||||
@echo
|
||||
@echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
|
||||
|
||||
.PHONY: latex
|
||||
latex:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo
|
||||
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
||||
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
||||
"(use \`make latexpdf' here to do that automatically)."
|
||||
|
||||
.PHONY: latexpdf
|
||||
latexpdf:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo "Running LaTeX files through pdflatex..."
|
||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||
|
||||
.PHONY: latexpdfja
|
||||
latexpdfja:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo "Running LaTeX files through platex and dvipdfmx..."
|
||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
|
||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||
|
||||
.PHONY: text
|
||||
text:
|
||||
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
||||
@echo
|
||||
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
||||
|
||||
.PHONY: man
|
||||
man:
|
||||
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
||||
@echo
|
||||
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
||||
|
||||
.PHONY: texinfo
|
||||
texinfo:
|
||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||
@echo
|
||||
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
|
||||
@echo "Run \`make' in that directory to run these through makeinfo" \
|
||||
"(use \`make info' here to do that automatically)."
|
||||
|
||||
.PHONY: info
|
||||
info:
|
||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||
@echo "Running Texinfo files through makeinfo..."
|
||||
make -C $(BUILDDIR)/texinfo info
|
||||
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
|
||||
|
||||
.PHONY: gettext
|
||||
gettext:
|
||||
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
||||
@echo
|
||||
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
||||
|
||||
.PHONY: changes
|
||||
changes:
|
||||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
||||
@echo
|
||||
@echo "The overview file is in $(BUILDDIR)/changes."
|
||||
|
||||
.PHONY: linkcheck
|
||||
linkcheck:
|
||||
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
||||
@echo
|
||||
@echo "Link check complete; look for any errors in the above output " \
|
||||
"or in $(BUILDDIR)/linkcheck/output.txt."
|
||||
|
||||
.PHONY: doctest
|
||||
doctest:
|
||||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
||||
@echo "Testing of doctests in the sources finished, look at the " \
|
||||
"results in $(BUILDDIR)/doctest/output.txt."
|
||||
|
||||
.PHONY: coverage
|
||||
coverage:
|
||||
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
|
||||
@echo "Testing of coverage in the sources finished, look at the " \
|
||||
"results in $(BUILDDIR)/coverage/python.txt."
|
||||
|
||||
.PHONY: xml
|
||||
xml:
|
||||
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
|
||||
@echo
|
||||
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
|
||||
|
||||
.PHONY: pseudoxml
|
||||
pseudoxml:
|
||||
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
|
||||
@echo
|
||||
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
|
||||
|
||||
.PHONY: dummy
|
||||
dummy:
|
||||
$(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
|
||||
@echo
|
||||
@echo "Build finished. Dummy builder generates no files."
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
Apache Cassandra documentation directory
|
||||
========================================
|
||||
|
||||
This directory contains the documentation maintained in-tree for Apache
|
||||
Cassandra. This directory contains the following documents:
|
||||
- The source of the official Cassandra documentation, in the `source/`
|
||||
subdirectory. See below for more details on how to edit/build that
|
||||
documentation.
|
||||
- The specification(s) for the supported versions of native transport protocol.
|
||||
- Additional documentation on the SASI implementation (`SASI.md`). TODO: we
|
||||
should probably move the first half of that documentation to the general
|
||||
documentation, and the implementation explanation parts into the wiki.
|
||||
|
||||
|
||||
Official documentation
|
||||
----------------------
|
||||
|
||||
The source for the official documentation for Apache Cassandra can be found in
|
||||
the `source` subdirectory. The documentation uses [sphinx](http://www.sphinx-doc.org/)
|
||||
and is thus written in [reStructuredText](http://docutils.sourceforge.net/rst.html).
|
||||
|
||||
To build the HTML documentation, you will need to first install sphinx and the
|
||||
[sphinx ReadTheDocs theme](the https://pypi.python.org/pypi/sphinx_rtd_theme), which
|
||||
on unix you can do with:
|
||||
```
|
||||
pip install sphinx sphinx_rtd_theme
|
||||
```
|
||||
|
||||
The documentation can then be built from this directory by calling `make html`
|
||||
(or `make.bat html` on windows). Alternatively, the top-level `ant gen-doc`
|
||||
target can be used.
|
||||
|
|
@ -0,0 +1,281 @@
|
|||
@ECHO OFF
|
||||
|
||||
REM Command file for Sphinx documentation
|
||||
|
||||
if "%SPHINXBUILD%" == "" (
|
||||
set SPHINXBUILD=sphinx-build
|
||||
)
|
||||
set BUILDDIR=build
|
||||
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
|
||||
set I18NSPHINXOPTS=%SPHINXOPTS% .
|
||||
if NOT "%PAPER%" == "" (
|
||||
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
|
||||
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
|
||||
)
|
||||
|
||||
if "%1" == "" goto help
|
||||
|
||||
if "%1" == "help" (
|
||||
:help
|
||||
echo.Please use `make ^<target^>` where ^<target^> is one of
|
||||
echo. html to make standalone HTML files
|
||||
echo. dirhtml to make HTML files named index.html in directories
|
||||
echo. singlehtml to make a single large HTML file
|
||||
echo. pickle to make pickle files
|
||||
echo. json to make JSON files
|
||||
echo. htmlhelp to make HTML files and a HTML help project
|
||||
echo. qthelp to make HTML files and a qthelp project
|
||||
echo. devhelp to make HTML files and a Devhelp project
|
||||
echo. epub to make an epub
|
||||
echo. epub3 to make an epub3
|
||||
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
|
||||
echo. text to make text files
|
||||
echo. man to make manual pages
|
||||
echo. texinfo to make Texinfo files
|
||||
echo. gettext to make PO message catalogs
|
||||
echo. changes to make an overview over all changed/added/deprecated items
|
||||
echo. xml to make Docutils-native XML files
|
||||
echo. pseudoxml to make pseudoxml-XML files for display purposes
|
||||
echo. linkcheck to check all external links for integrity
|
||||
echo. doctest to run all doctests embedded in the documentation if enabled
|
||||
echo. coverage to run coverage check of the documentation if enabled
|
||||
echo. dummy to check syntax errors of document sources
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "clean" (
|
||||
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
|
||||
del /q /s %BUILDDIR%\*
|
||||
goto end
|
||||
)
|
||||
|
||||
|
||||
REM Check if sphinx-build is available and fallback to Python version if any
|
||||
%SPHINXBUILD% 1>NUL 2>NUL
|
||||
if errorlevel 9009 goto sphinx_python
|
||||
goto sphinx_ok
|
||||
|
||||
:sphinx_python
|
||||
|
||||
set SPHINXBUILD=python -m sphinx.__init__
|
||||
%SPHINXBUILD% 2> nul
|
||||
if errorlevel 9009 (
|
||||
echo.
|
||||
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
||||
echo.installed, then set the SPHINXBUILD environment variable to point
|
||||
echo.to the full path of the 'sphinx-build' executable. Alternatively you
|
||||
echo.may add the Sphinx directory to PATH.
|
||||
echo.
|
||||
echo.If you don't have Sphinx installed, grab it from
|
||||
echo.http://sphinx-doc.org/
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
:sphinx_ok
|
||||
|
||||
|
||||
if "%1" == "html" (
|
||||
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The HTML pages are in %BUILDDIR%/html.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "dirhtml" (
|
||||
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "singlehtml" (
|
||||
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "pickle" (
|
||||
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished; now you can process the pickle files.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "json" (
|
||||
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished; now you can process the JSON files.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "htmlhelp" (
|
||||
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished; now you can run HTML Help Workshop with the ^
|
||||
.hhp project file in %BUILDDIR%/htmlhelp.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "qthelp" (
|
||||
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished; now you can run "qcollectiongenerator" with the ^
|
||||
.qhcp project file in %BUILDDIR%/qthelp, like this:
|
||||
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Foo.qhcp
|
||||
echo.To view the help file:
|
||||
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Foo.ghc
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "devhelp" (
|
||||
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "epub" (
|
||||
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The epub file is in %BUILDDIR%/epub.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "epub3" (
|
||||
%SPHINXBUILD% -b epub3 %ALLSPHINXOPTS% %BUILDDIR%/epub3
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The epub3 file is in %BUILDDIR%/epub3.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "latex" (
|
||||
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "latexpdf" (
|
||||
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
|
||||
cd %BUILDDIR%/latex
|
||||
make all-pdf
|
||||
cd %~dp0
|
||||
echo.
|
||||
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "latexpdfja" (
|
||||
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
|
||||
cd %BUILDDIR%/latex
|
||||
make all-pdf-ja
|
||||
cd %~dp0
|
||||
echo.
|
||||
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "text" (
|
||||
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The text files are in %BUILDDIR%/text.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "man" (
|
||||
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The manual pages are in %BUILDDIR%/man.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "texinfo" (
|
||||
%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "gettext" (
|
||||
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "changes" (
|
||||
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.The overview file is in %BUILDDIR%/changes.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "linkcheck" (
|
||||
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Link check complete; look for any errors in the above output ^
|
||||
or in %BUILDDIR%/linkcheck/output.txt.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "doctest" (
|
||||
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Testing of doctests in the sources finished, look at the ^
|
||||
results in %BUILDDIR%/doctest/output.txt.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "coverage" (
|
||||
%SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Testing of coverage in the sources finished, look at the ^
|
||||
results in %BUILDDIR%/coverage/python.txt.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "xml" (
|
||||
%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The XML files are in %BUILDDIR%/xml.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "pseudoxml" (
|
||||
%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "dummy" (
|
||||
%SPHINXBUILD% -b dummy %ALLSPHINXOPTS% %BUILDDIR%/dummy
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. Dummy builder generates no files.
|
||||
goto end
|
||||
)
|
||||
|
||||
:end
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
div:not(.highlight) > pre {
|
||||
background: #fff;
|
||||
border: 1px solid #e1e4e5;
|
||||
color: #404040;
|
||||
margin: 1px 0 24px 0;
|
||||
overflow-x: auto;
|
||||
padding: 12px 12px;
|
||||
font-size: 12px;
|
||||
}
|
||||
|
||||
a.reference.internal code.literal {
|
||||
border: none;
|
||||
font-size: 12px;
|
||||
color: #2980B9;
|
||||
}
|
||||
|
||||
a.reference.internal:visited code.literal {
|
||||
color: #9B59B6;
|
||||
}
|
||||
|
|
@ -0,0 +1,74 @@
|
|||
.. Licensed to the Apache Software Foundation (ASF) under one
|
||||
.. or more contributor license agreements. See the NOTICE file
|
||||
.. distributed with this work for additional information
|
||||
.. regarding copyright ownership. The ASF licenses this file
|
||||
.. to you under the Apache License, Version 2.0 (the
|
||||
.. "License"); you may not use this file except in compliance
|
||||
.. with the License. You may obtain a copy of the License at
|
||||
..
|
||||
.. http://www.apache.org/licenses/LICENSE-2.0
|
||||
..
|
||||
.. Unless required by applicable law or agreed to in writing, software
|
||||
.. distributed under the License is distributed on an "AS IS" BASIS,
|
||||
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
.. See the License for the specific language governing permissions and
|
||||
.. limitations under the License.
|
||||
|
||||
Architecture
|
||||
============
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
.. todo:: todo
|
||||
|
||||
Dynamo
|
||||
------
|
||||
|
||||
Gossip
|
||||
^^^^^^
|
||||
|
||||
.. todo:: todo
|
||||
|
||||
Failure Detection
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. todo:: todo
|
||||
|
||||
Token Ring/Ranges
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. todo:: todo
|
||||
|
||||
Replication
|
||||
^^^^^^^^^^^
|
||||
|
||||
.. todo:: todo
|
||||
|
||||
Tunable Consistency
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. todo:: todo
|
||||
|
||||
Storage Engine
|
||||
--------------
|
||||
|
||||
CommitLog
|
||||
^^^^^^^^^
|
||||
|
||||
.. todo:: todo
|
||||
|
||||
Memtables
|
||||
^^^^^^^^^
|
||||
|
||||
.. todo:: todo
|
||||
|
||||
SSTables
|
||||
^^^^^^^^
|
||||
|
||||
.. todo:: todo
|
||||
|
||||
Guarantees
|
||||
----------
|
||||
|
||||
.. todo:: todo
|
||||
|
|
@ -0,0 +1,430 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Licensed to the Apache Software Foundation (ASF) under one
|
||||
# or more contributor license agreements. See the NOTICE file
|
||||
# distributed with this work for additional information
|
||||
# regarding copyright ownership. The ASF licenses this file
|
||||
# to you under the Apache License, Version 2.0 (the
|
||||
# "License"); you may not use this file except in compliance
|
||||
# with the License. You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
#
|
||||
# Apache Cassandra Documentation documentation build configuration file
|
||||
#
|
||||
# This file is execfile()d with the current directory set to its containing
|
||||
# dir.
|
||||
import re
|
||||
|
||||
# Finds out the version (so we don't have to manually edit that file every
|
||||
# time we change the version)
|
||||
cassandra_build_file = '../../build.xml'
|
||||
with open(cassandra_build_file) as f:
|
||||
m = re.search("name=\"base\.version\" value=\"([^\"]+)\"", f.read())
|
||||
if not m or m.lastindex != 1:
|
||||
raise RuntimeException("Problem finding version in build.xml file, this shouldn't happen.")
|
||||
cassandra_version = m.group(1)
|
||||
|
||||
|
||||
|
||||
# -- General configuration ------------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
# needs_sphinx = '1.0'
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = [
|
||||
'sphinx.ext.todo',
|
||||
'sphinx.ext.mathjax',
|
||||
'sphinx.ext.ifconfig',
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# The suffix(es) of source filenames.
|
||||
# You can specify multiple suffix as a list of string:
|
||||
source_suffix = ['.rst']
|
||||
|
||||
# The encoding of source files.
|
||||
#
|
||||
# source_encoding = 'utf-8-sig'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'Apache Cassandra'
|
||||
copyright = u'2016, The Apache Cassandra team'
|
||||
author = u'The Apache Cassandra team'
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
# built documents.
|
||||
version = cassandra_version
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#
|
||||
# This is also used if you do content translation via gettext catalogs.
|
||||
# Usually you set "language" from the command line for these cases.
|
||||
language = None
|
||||
|
||||
# There are two options for replacing |today|: either, you set today to some
|
||||
# non-false value, then it is used:
|
||||
#
|
||||
# today = ''
|
||||
#
|
||||
# Else, today_fmt is used as the format for a strftime call.
|
||||
#
|
||||
# today_fmt = '%B %d, %Y'
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
# This patterns also effect to html_static_path and html_extra_path
|
||||
exclude_patterns = []
|
||||
|
||||
# The reST default role (used for this markup: `text`) to use for all
|
||||
# documents.
|
||||
#
|
||||
# default_role = None
|
||||
|
||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||
#
|
||||
# add_function_parentheses = True
|
||||
|
||||
# If true, the current module name will be prepended to all description
|
||||
# unit titles (such as .. function::).
|
||||
#
|
||||
# add_module_names = True
|
||||
|
||||
# If true, sectionauthor and moduleauthor directives will be shown in the
|
||||
# output. They are ignored by default.
|
||||
#
|
||||
# show_authors = False
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
|
||||
# A list of ignored prefixes for module index sorting.
|
||||
# modindex_common_prefix = []
|
||||
|
||||
# If true, keep warnings as "system message" paragraphs in the built documents.
|
||||
# keep_warnings = False
|
||||
|
||||
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
||||
todo_include_todos = True
|
||||
|
||||
|
||||
# -- Options for HTML output ----------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
html_theme = 'sphinx_rtd_theme'
|
||||
|
||||
html_context = { 'extra_css_files': [ '_static/extra.css' ] }
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
# documentation.
|
||||
#
|
||||
# html_theme_options = {}
|
||||
|
||||
# Add any paths that contain custom themes here, relative to this directory.
|
||||
#html_theme_path = ['.']
|
||||
|
||||
# The name for this set of Sphinx documents.
|
||||
# "<project> v<release> documentation" by default.
|
||||
#
|
||||
html_title = u'Apache Cassandra Documentation v%s' % version
|
||||
|
||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||
#
|
||||
# html_short_title = None
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top
|
||||
# of the sidebar.
|
||||
#
|
||||
# html_logo = None
|
||||
|
||||
# The name of an image file (relative to this directory) to use as a favicon of
|
||||
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
||||
# pixels large.
|
||||
#
|
||||
# html_favicon = None
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
||||
|
||||
# Add any extra paths that contain custom files (such as robots.txt or
|
||||
# .htaccess) here, relative to this directory. These files are copied
|
||||
# directly to the root of the documentation.
|
||||
#
|
||||
# html_extra_path = []
|
||||
|
||||
# If not None, a 'Last updated on:' timestamp is inserted at every page
|
||||
# bottom, using the given strftime format.
|
||||
# The empty string is equivalent to '%b %d, %Y'.
|
||||
#
|
||||
# html_last_updated_fmt = None
|
||||
|
||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||
# typographically correct entities.
|
||||
#
|
||||
# html_use_smartypants = True
|
||||
|
||||
# Custom sidebar templates, maps document names to template names.
|
||||
#
|
||||
# html_sidebars = {}
|
||||
|
||||
# Additional templates that should be rendered to pages, maps page names to
|
||||
# template names.
|
||||
#
|
||||
# html_additional_pages = {}
|
||||
|
||||
# If false, no module index is generated.
|
||||
#
|
||||
# html_domain_indices = True
|
||||
|
||||
# If false, no index is generated.
|
||||
#
|
||||
# html_use_index = True
|
||||
|
||||
# If true, the index is split into individual pages for each letter.
|
||||
#
|
||||
# html_split_index = False
|
||||
|
||||
# If true, links to the reST sources are added to the pages.
|
||||
#
|
||||
# html_show_sourcelink = True
|
||||
|
||||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
||||
#
|
||||
# html_show_sphinx = True
|
||||
|
||||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
||||
#
|
||||
# html_show_copyright = True
|
||||
|
||||
# If true, an OpenSearch description file will be output, and all pages will
|
||||
# contain a <link> tag referring to it. The value of this option must be the
|
||||
# base URL from which the finished HTML is served.
|
||||
#
|
||||
# html_use_opensearch = ''
|
||||
|
||||
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
||||
# html_file_suffix = None
|
||||
|
||||
# Language to be used for generating the HTML full-text search index.
|
||||
# Sphinx supports the following languages:
|
||||
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
|
||||
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
|
||||
#
|
||||
# html_search_language = 'en'
|
||||
|
||||
# A dictionary with options for the search language support, empty by default.
|
||||
# 'ja' uses this config value.
|
||||
# 'zh' user can custom change `jieba` dictionary path.
|
||||
#
|
||||
# html_search_options = {'type': 'default'}
|
||||
|
||||
# The name of a javascript file (relative to the configuration directory) that
|
||||
# implements a search results scorer. If empty, the default will be used.
|
||||
#
|
||||
# html_search_scorer = 'scorer.js'
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'ApacheCassandraDocumentationdoc'
|
||||
|
||||
# -- Options for LaTeX output ---------------------------------------------
|
||||
|
||||
latex_elements = {
|
||||
# The paper size ('letterpaper' or 'a4paper').
|
||||
#
|
||||
# 'papersize': 'letterpaper',
|
||||
|
||||
# The font size ('10pt', '11pt' or '12pt').
|
||||
#
|
||||
# 'pointsize': '10pt',
|
||||
|
||||
# Additional stuff for the LaTeX preamble.
|
||||
#
|
||||
# 'preamble': '',
|
||||
|
||||
# Latex figure (float) alignment
|
||||
#
|
||||
# 'figure_align': 'htbp',
|
||||
}
|
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title,
|
||||
# author, documentclass [howto, manual, or own class]).
|
||||
latex_documents = [
|
||||
(master_doc, 'ApacheCassandra.tex', u'Apache Cassandra Documentation',
|
||||
u'The Apache Cassandra team', 'manual'),
|
||||
]
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top of
|
||||
# the title page.
|
||||
#
|
||||
# latex_logo = None
|
||||
|
||||
# For "manual" documents, if this is true, then toplevel headings are parts,
|
||||
# not chapters.
|
||||
#
|
||||
# latex_use_parts = False
|
||||
|
||||
# If true, show page references after internal links.
|
||||
#
|
||||
# latex_show_pagerefs = False
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#
|
||||
# latex_show_urls = False
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#
|
||||
# latex_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#
|
||||
# latex_domain_indices = True
|
||||
|
||||
|
||||
# -- Options for manual page output ---------------------------------------
|
||||
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
(master_doc, 'apachecassandra', u'Apache Cassandra Documentation',
|
||||
[author], 1)
|
||||
]
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#
|
||||
# man_show_urls = False
|
||||
|
||||
|
||||
# -- Options for Texinfo output -------------------------------------------
|
||||
|
||||
# Grouping the document tree into Texinfo files. List of tuples
|
||||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
(master_doc, 'ApacheCassandra', u'Apache Cassandra Documentation',
|
||||
author, 'ApacheCassandraDocumentation', 'One line description of project.',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#
|
||||
# texinfo_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#
|
||||
# texinfo_domain_indices = True
|
||||
|
||||
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||
#
|
||||
# texinfo_show_urls = 'footnote'
|
||||
|
||||
# If true, do not generate a @detailmenu in the "Top" node's menu.
|
||||
#
|
||||
# texinfo_no_detailmenu = False
|
||||
|
||||
|
||||
# -- Options for Epub output ----------------------------------------------
|
||||
|
||||
# Bibliographic Dublin Core info.
|
||||
epub_title = project
|
||||
epub_author = author
|
||||
epub_publisher = author
|
||||
epub_copyright = copyright
|
||||
|
||||
# The basename for the epub file. It defaults to the project name.
|
||||
# epub_basename = project
|
||||
|
||||
# The HTML theme for the epub output. Since the default themes are not
|
||||
# optimized for small screen space, using the same theme for HTML and epub
|
||||
# output is usually not wise. This defaults to 'epub', a theme designed to save
|
||||
# visual space.
|
||||
#
|
||||
# epub_theme = 'epub'
|
||||
|
||||
# The language of the text. It defaults to the language option
|
||||
# or 'en' if the language is not set.
|
||||
#
|
||||
# epub_language = ''
|
||||
|
||||
# The scheme of the identifier. Typical schemes are ISBN or URL.
|
||||
# epub_scheme = ''
|
||||
|
||||
# The unique identifier of the text. This can be a ISBN number
|
||||
# or the project homepage.
|
||||
#
|
||||
# epub_identifier = ''
|
||||
|
||||
# A unique identification for the text.
|
||||
#
|
||||
# epub_uid = ''
|
||||
|
||||
# A tuple containing the cover image and cover page html template filenames.
|
||||
#
|
||||
# epub_cover = ()
|
||||
|
||||
# A sequence of (type, uri, title) tuples for the guide element of content.opf.
|
||||
#
|
||||
# epub_guide = ()
|
||||
|
||||
# HTML files that should be inserted before the pages created by sphinx.
|
||||
# The format is a list of tuples containing the path and title.
|
||||
#
|
||||
# epub_pre_files = []
|
||||
|
||||
# HTML files that should be inserted after the pages created by sphinx.
|
||||
# The format is a list of tuples containing the path and title.
|
||||
#
|
||||
# epub_post_files = []
|
||||
|
||||
# A list of files that should not be packed into the epub file.
|
||||
epub_exclude_files = ['search.html']
|
||||
|
||||
# The depth of the table of contents in toc.ncx.
|
||||
#
|
||||
# epub_tocdepth = 3
|
||||
|
||||
# Allow duplicate toc entries.
|
||||
#
|
||||
# epub_tocdup = True
|
||||
|
||||
# Choose between 'default' and 'includehidden'.
|
||||
#
|
||||
# epub_tocscope = 'default'
|
||||
|
||||
# Fix unsupported image types using the Pillow.
|
||||
#
|
||||
# epub_fix_images = False
|
||||
|
||||
# Scale large images.
|
||||
#
|
||||
# epub_max_image_width = 0
|
||||
|
||||
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||
#
|
||||
# epub_show_urls = 'inline'
|
||||
|
||||
# If false, no index is generated.
|
||||
#
|
||||
# epub_use_index = True
|
||||
|
|
@ -0,0 +1,49 @@
|
|||
.. Licensed to the Apache Software Foundation (ASF) under one
|
||||
.. or more contributor license agreements. See the NOTICE file
|
||||
.. distributed with this work for additional information
|
||||
.. regarding copyright ownership. The ASF licenses this file
|
||||
.. to you under the Apache License, Version 2.0 (the
|
||||
.. "License"); you may not use this file except in compliance
|
||||
.. with the License. You may obtain a copy of the License at
|
||||
..
|
||||
.. http://www.apache.org/licenses/LICENSE-2.0
|
||||
..
|
||||
.. Unless required by applicable law or agreed to in writing, software
|
||||
.. distributed under the License is distributed on an "AS IS" BASIS,
|
||||
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
.. See the License for the specific language governing permissions and
|
||||
.. limitations under the License.
|
||||
|
||||
Contact us
|
||||
==========
|
||||
|
||||
You can get in touch with the Cassandra community either via the mailing lists or the freenode IRC channels.
|
||||
|
||||
Mailing lists
|
||||
-------------
|
||||
|
||||
The following mailing lists are available:
|
||||
|
||||
- `Users <http://www.mail-archive.com/user@cassandra.apache.org/>`__ – General discussion list for users - `Subscribe
|
||||
<user-subscribe@cassandra.apache.org>`__
|
||||
- `Developers <http://www.mail-archive.com/dev@cassandra.apache.org/>`__ – Development related discussion - `Subscribe
|
||||
<dev-subscribe@cassandra.apache.org>`__
|
||||
- `Commits <http://www.mail-archive.com/commits@cassandra.apache.org/>`__ – Commit notification source repository -
|
||||
`Subscribe <commits-subscribe@cassandra.apache.org>`__
|
||||
- `Client Libraries <http://www.mail-archive.com/client-dev@cassandra.apache.org/>`__ – Discussion related to the
|
||||
development of idiomatic client APIs - `Subscribe <client-dev-subscribe@cassandra.apache.org>`__
|
||||
|
||||
Subscribe by sending an email to the email address in the Subscribe links above. Follow the instructions in the welcome
|
||||
email to confirm your subscription. Make sure to keep the welcome email as it contains instructions on how to
|
||||
unsubscribe.
|
||||
|
||||
IRC
|
||||
---
|
||||
|
||||
To chat with developers or users in real-time, join our channels on `IRC freenode <http://webchat.freenode.net/>`__. The
|
||||
following channels are available:
|
||||
|
||||
- ``#cassandra`` - for user questions and general discussions.
|
||||
- ``#cassandra-dev`` - strictly for questions or discussions related to Cassandra development.
|
||||
- ``#cassandra-builds`` - results of automated test builds.
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,20 @@
|
|||
.. Licensed to the Apache Software Foundation (ASF) under one
|
||||
.. or more contributor license agreements. See the NOTICE file
|
||||
.. distributed with this work for additional information
|
||||
.. regarding copyright ownership. The ASF licenses this file
|
||||
.. to you under the Apache License, Version 2.0 (the
|
||||
.. "License"); you may not use this file except in compliance
|
||||
.. with the License. You may obtain a copy of the License at
|
||||
..
|
||||
.. http://www.apache.org/licenses/LICENSE-2.0
|
||||
..
|
||||
.. Unless required by applicable law or agreed to in writing, software
|
||||
.. distributed under the License is distributed on an "AS IS" BASIS,
|
||||
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
.. See the License for the specific language governing permissions and
|
||||
.. limitations under the License.
|
||||
|
||||
Frequently Asked Questions
|
||||
==========================
|
||||
|
||||
.. TODO: todo
|
||||
|
|
@ -0,0 +1,252 @@
|
|||
.. Licensed to the Apache Software Foundation (ASF) under one
|
||||
.. or more contributor license agreements. See the NOTICE file
|
||||
.. distributed with this work for additional information
|
||||
.. regarding copyright ownership. The ASF licenses this file
|
||||
.. to you under the Apache License, Version 2.0 (the
|
||||
.. "License"); you may not use this file except in compliance
|
||||
.. with the License. You may obtain a copy of the License at
|
||||
..
|
||||
.. http://www.apache.org/licenses/LICENSE-2.0
|
||||
..
|
||||
.. Unless required by applicable law or agreed to in writing, software
|
||||
.. distributed under the License is distributed on an "AS IS" BASIS,
|
||||
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
.. See the License for the specific language governing permissions and
|
||||
.. limitations under the License.
|
||||
|
||||
.. highlight:: none
|
||||
|
||||
Getting Started
|
||||
===============
|
||||
|
||||
Installing Cassandra
|
||||
--------------------
|
||||
|
||||
Prerequisites
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
- The latest version of Java 8, either the `Oracle Java Standard Edition 8
|
||||
<http://www.oracle.com/technetwork/java/javase/downloads/index.html>`__ or `OpenJDK 8 <http://openjdk.java.net/>`__. To
|
||||
verify that you have the correct version of java installed, type ``java -version``.
|
||||
|
||||
- For using cqlsh, the latest version of `Python 2.7 <https://www.python.org/downloads/>`__. To verify that you have
|
||||
the correct version of Python installed, type ``python --version``.
|
||||
|
||||
Installation from binary tarball files
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
- Download the latest stable release from the `Apache Cassandra downloads website <http://cassandra.apache.org/download/>`__.
|
||||
|
||||
- Untar the file somewhere, for example:
|
||||
|
||||
::
|
||||
|
||||
tar -xvf apache-cassandra-3.6-bin.tar.gz cassandra
|
||||
|
||||
The files will be extracted into ``apache-cassandra-3.6``, you need to substitute 3.6 with the release number that you
|
||||
have downloaded.
|
||||
|
||||
- Optionally add ``apache-cassandra-3.6\bin`` to your path.
|
||||
- Start Cassandra in the foreground by invoking ``bin/cassandra -f`` from the command line. Press "Control-C" to stop
|
||||
Cassandra. Start Cassandra in the background by invoking ``bin/cassandra`` from the command line. Invoke ``kill pid``
|
||||
or ``pkill -f CassandraDaemon`` to stop Cassandra, where pid is the Cassandra process id, which you can find for
|
||||
example by invoking ``pgrep -f CassandraDaemon``.
|
||||
- Verify that Cassandra is running by invoking ``bin/nodetool status`` from the command line.
|
||||
- Configuration files are located in the ``conf`` sub-directory.
|
||||
- Since Cassandra 2.1, log and data directories are located in the ``logs`` and ``data`` sub-directories respectively.
|
||||
Older versions defaulted to ``/var/log/cassandra`` and ``/var/lib/cassandra``. Due to this, it is necessary to either
|
||||
start Cassandra with root privileges or change ``conf/cassandra.yaml`` to use directories owned by the current user,
|
||||
as explained below in the section on changing the location of directories.
|
||||
|
||||
Installation from Debian packages
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
- Add the Apache repository of Cassandra to ``/etc/apt/sources.list.d/cassandra.sources.list``, for example for version
|
||||
3.6:
|
||||
|
||||
::
|
||||
|
||||
echo "deb http://www.apache.org/dist/cassandra/debian 36x main" | sudo tee -a /etc/apt/sources.list.d/cassandra.sources.list
|
||||
|
||||
- Update the repositories:
|
||||
|
||||
::
|
||||
|
||||
sudo apt-get update
|
||||
|
||||
- If you encounter this error:
|
||||
|
||||
::
|
||||
|
||||
GPG error: http://www.apache.org 36x InRelease: The following signatures couldn't be verified because the public key is not available: NO_PUBKEY 749D6EEC0353B12C
|
||||
|
||||
Then add the public key 749D6EEC0353B12C as follows:
|
||||
|
||||
::
|
||||
|
||||
gpg --keyserver pgp.mit.edu --recv-keys 749D6EEC0353B12C
|
||||
gpg --export --armor 749D6EEC0353B12C | sudo apt-key add -
|
||||
|
||||
and repeat ``sudo apt-get update``. The actual key may be different, you get it from the error message itself. For a
|
||||
full list of Apache contributors public keys, you can refer to `this link <https://www.apache.org/dist/cassandra/KEYS>`__.
|
||||
|
||||
- Install Cassandra:
|
||||
|
||||
::
|
||||
|
||||
sudo apt-get install cassandra
|
||||
|
||||
- You can start Cassandra with ``sudo service cassandra start`` and stop it with ``sudo service cassandra stop``.
|
||||
However, normally the service will start automatically. For this reason be sure to stop it if you need to make any
|
||||
configuration changes.
|
||||
- Verify that Cassandra is running by invoking ``nodetool status`` from the command line.
|
||||
- The default location of configuration files is ``/etc/cassandra``.
|
||||
- The default location of log and data directories is ``/var/log/cassandra/`` and ``/var/lib/cassandra``.
|
||||
|
||||
Configuring Cassandra
|
||||
---------------------
|
||||
|
||||
For running Cassandra on a single node, the steps above are enough, you don't really need to change any configuration.
|
||||
However, when you deploy a cluster of nodes, or use clients that are not on the same host, then there are some
|
||||
parameters that must be changed.
|
||||
|
||||
The Cassandra configuration files can be found in the ``conf`` directory of tarballs. For packages, the configuration
|
||||
files will be located in ``/etc/cassandra``.
|
||||
|
||||
Main runtime properties
|
||||
^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Most of configuration in Cassandra is done via yaml properties that can be set in ``cassandra.yaml``. At a minimum you
|
||||
should consider setting the following properties:
|
||||
|
||||
- ``cluster_name``: the name of your cluster.
|
||||
- ``seeds``: a comma separated list of the IP addresses of your cluster seeds.
|
||||
- ``storage_port``: you don't necessarily need to change this but make sure that there are no firewalls blocking this
|
||||
port.
|
||||
- ``listen_address``: the IP address of your node, this is what allows other nodes to communicate with this node so it
|
||||
is important that you change it. Alternatively, you can set ``listen_interface`` to tell Cassandra which interface to
|
||||
use, and consecutively which address to use. Set only one, not both.
|
||||
- ``native_transport_port``: as for storage\_port, make sure this port is not blocked by firewalls as clients will
|
||||
communicate with Cassandra on this port.
|
||||
|
||||
Changing the location of directories
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The following yaml properties control the location of directories:
|
||||
|
||||
- ``data_file_directories``: one or more directories where data files are located.
|
||||
- ``commitlog_directory``: the directory where commitlog files are located.
|
||||
- ``saved_caches_directory``: the directory where saved caches are located.
|
||||
- ``hints_directory``: the directory where hints are located.
|
||||
|
||||
For performance reasons, if you have multiple disks, consider putting commitlog and data files on different disks.
|
||||
|
||||
Environment variables
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
JVM-level settings such as heap size can be set in ``cassandra-env.sh``. You can add any additional JVM command line
|
||||
argument to the ``JVM_OPTS`` environment variable; when Cassandra starts these arguments will be passed to the JVM.
|
||||
|
||||
Logging
|
||||
^^^^^^^
|
||||
|
||||
The logger in use is logback. You can change logging properties by editing ``logback.xml``. By default it will log at
|
||||
INFO level into a file called ``system.log`` and at debug level into a file called ``debug.log``. When running in the
|
||||
foreground, it will also log at INFO level to the console.
|
||||
|
||||
|
||||
cqlsh
|
||||
-----
|
||||
|
||||
.. todo:: TODO
|
||||
|
||||
|
||||
Cassandra client drivers
|
||||
------------------------
|
||||
|
||||
Here are known Cassandra client drivers organized by language. Before choosing a driver, you should verify the Cassandra
|
||||
version and functionality supported by a specific driver.
|
||||
|
||||
Java
|
||||
^^^^
|
||||
|
||||
- `Achilles <http://achilles.archinnov.info/>`__
|
||||
- `Astyanax <https://github.com/Netflix/astyanax/wiki/Getting-Started>`__
|
||||
- `Casser <https://github.com/noorq/casser>`__
|
||||
- `Datastax Java driver <https://github.com/datastax/java-driver>`__
|
||||
- `Kundera <https://github.com/impetus-opensource/Kundera>`__
|
||||
- `PlayORM <https://github.com/deanhiller/playorm>`__
|
||||
|
||||
Python
|
||||
^^^^^^
|
||||
|
||||
- `Datastax Python driver <https://github.com/datastax/python-driver>`__
|
||||
|
||||
Ruby
|
||||
^^^^
|
||||
|
||||
- `Datastax Ruby driver <https://github.com/datastax/ruby-driver>`__
|
||||
|
||||
C# / .NET
|
||||
^^^^^^^^^
|
||||
|
||||
- `Cassandra Sharp <https://github.com/pchalamet/cassandra-sharp>`__
|
||||
- `Datastax C# driver <https://github.com/datastax/csharp-driver>`__
|
||||
- `Fluent Cassandra <https://github.com/managedfusion/fluentcassandra>`__
|
||||
|
||||
Nodejs
|
||||
^^^^^^
|
||||
|
||||
- `Datastax Nodejs driver <https://github.com/datastax/nodejs-driver>`__
|
||||
- `Node-Cassandra-CQL <https://github.com/jorgebay/node-cassandra-cql>`__
|
||||
|
||||
PHP
|
||||
^^^
|
||||
|
||||
- `CQL \| PHP <http://code.google.com/a/apache-extras.org/p/cassandra-pdo>`__
|
||||
- `Datastax PHP driver <https://github.com/datastax/php-driver/>`__
|
||||
- `PHP-Cassandra <https://github.com/aparkhomenko/php-cassandra>`__
|
||||
- `PHP Library for Cassandra <http://evseevnn.github.io/php-cassandra-binary/>`__
|
||||
|
||||
C++
|
||||
^^^
|
||||
|
||||
- `Datastax C++ driver <https://github.com/datastax/cpp-driver>`__
|
||||
- `libQTCassandra <http://sourceforge.net/projects/libqtcassandra>`__
|
||||
|
||||
Scala
|
||||
^^^^^
|
||||
|
||||
- `Datastax Spark connector <https://github.com/datastax/spark-cassandra-connector>`__
|
||||
- `Phantom <https://github.com/newzly/phantom>`__
|
||||
- `Quill <https://github.com/getquill/quill>`__
|
||||
|
||||
Clojure
|
||||
^^^^^^^
|
||||
|
||||
- `Alia <https://github.com/mpenet/alia>`__
|
||||
- `Cassaforte <https://github.com/clojurewerkz/cassaforte>`__
|
||||
- `Hayt <https://github.com/mpenet/hayt>`__
|
||||
|
||||
Erlang
|
||||
^^^^^^
|
||||
|
||||
- `CQerl <https://github.com/matehat/cqerl>`__
|
||||
- `Erlcass <https://github.com/silviucpp/erlcass>`__
|
||||
|
||||
Go
|
||||
^^
|
||||
|
||||
- `CQLc <http://relops.com/cqlc/>`__
|
||||
- `Gocassa <https://github.com/hailocab/gocassa>`__
|
||||
- `GoCQL <https://github.com/gocql/gocql>`__
|
||||
|
||||
Haskell
|
||||
^^^^^^^
|
||||
|
||||
- `Cassy <https://github.com/ozataman/cassy>`__
|
||||
|
||||
Rust
|
||||
^^^^
|
||||
|
||||
- `Rust CQL <https://github.com/neich/rust-cql>`__
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
.. Licensed to the Apache Software Foundation (ASF) under one
|
||||
.. or more contributor license agreements. See the NOTICE file
|
||||
.. distributed with this work for additional information
|
||||
.. regarding copyright ownership. The ASF licenses this file
|
||||
.. to you under the Apache License, Version 2.0 (the
|
||||
.. "License"); you may not use this file except in compliance
|
||||
.. with the License. You may obtain a copy of the License at
|
||||
..
|
||||
.. http://www.apache.org/licenses/LICENSE-2.0
|
||||
..
|
||||
.. Unless required by applicable law or agreed to in writing, software
|
||||
.. distributed under the License is distributed on an "AS IS" BASIS,
|
||||
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
.. See the License for the specific language governing permissions and
|
||||
.. limitations under the License.
|
||||
|
||||
Welcome to Apache Cassandra's documentation!
|
||||
============================================
|
||||
|
||||
This is the official documentation for `Apache Cassandra <http://cassandra.apache.org>`__ |version|. If you would like
|
||||
to contribute to this documentation, you are welcome to do so by submitting your contribution like any other patch
|
||||
following `these instructions <https://wiki.apache.org/cassandra/HowToContribute>`__.
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
getting_started
|
||||
architecture
|
||||
cql
|
||||
operations
|
||||
troubleshooting
|
||||
faq
|
||||
contactus
|
||||
|
|
@ -0,0 +1,369 @@
|
|||
.. Licensed to the Apache Software Foundation (ASF) under one
|
||||
.. or more contributor license agreements. See the NOTICE file
|
||||
.. distributed with this work for additional information
|
||||
.. regarding copyright ownership. The ASF licenses this file
|
||||
.. to you under the Apache License, Version 2.0 (the
|
||||
.. "License"); you may not use this file except in compliance
|
||||
.. with the License. You may obtain a copy of the License at
|
||||
..
|
||||
.. http://www.apache.org/licenses/LICENSE-2.0
|
||||
..
|
||||
.. Unless required by applicable law or agreed to in writing, software
|
||||
.. distributed under the License is distributed on an "AS IS" BASIS,
|
||||
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
.. See the License for the specific language governing permissions and
|
||||
.. limitations under the License.
|
||||
|
||||
.. highlight:: none
|
||||
|
||||
Operating Cassandra
|
||||
===================
|
||||
|
||||
Replication Strategies
|
||||
----------------------
|
||||
|
||||
.. todo:: todo
|
||||
|
||||
Snitches
|
||||
--------
|
||||
|
||||
.. todo:: todo
|
||||
|
||||
Adding, replacing, moving and removing nodes
|
||||
--------------------------------------------
|
||||
|
||||
.. todo:: todo
|
||||
|
||||
Repair
|
||||
------
|
||||
|
||||
.. todo:: todo
|
||||
|
||||
Read repair
|
||||
-----------
|
||||
|
||||
.. todo:: todo
|
||||
|
||||
Hints
|
||||
-----
|
||||
|
||||
.. todo:: todo
|
||||
|
||||
Compaction
|
||||
----------
|
||||
|
||||
Size Tiered
|
||||
^^^^^^^^^^^
|
||||
|
||||
.. todo:: todo
|
||||
|
||||
Leveled
|
||||
^^^^^^^
|
||||
|
||||
.. todo:: todo
|
||||
|
||||
TimeWindow
|
||||
^^^^^^^^^^
|
||||
.. todo:: todo
|
||||
|
||||
DateTiered
|
||||
^^^^^^^^^^
|
||||
.. todo:: todo
|
||||
|
||||
Tombstones and Garbage Collection (GC) Grace
|
||||
--------------------------------------------
|
||||
|
||||
Why Tombstones
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
When a delete request is received by Cassandra it does not actually remove the data from the underlying store. Instead
|
||||
it writes a special piece of data known as a tombstone. The Tombstone represents the delete and causes all values which
|
||||
occurred before the tombstone to not appear in queries to the database. This approach is used instead of removing values
|
||||
because of the distributed nature of Cassandra.
|
||||
|
||||
Deletes without tombstones
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Imagine a three node cluster which has the value [A] replicated to every node.::
|
||||
|
||||
[A], [A], [A]
|
||||
|
||||
If one of the nodes fails and and our delete operation only removes existing values we can end up with a cluster that
|
||||
looks like::
|
||||
|
||||
[], [], [A]
|
||||
|
||||
Then a repair operation would replace the value of [A] back onto the two
|
||||
nodes which are missing the value.::
|
||||
|
||||
[A], [A], [A]
|
||||
|
||||
This would cause our data to be resurrected even though it had been
|
||||
deleted.
|
||||
|
||||
Deletes with Tombstones
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Starting again with a three node cluster which has the value [A] replicated to every node.::
|
||||
|
||||
[A], [A], [A]
|
||||
|
||||
If instead of removing data we add a tombstone record, our single node failure situation will look like this.::
|
||||
|
||||
[A, Tombstone[A]], [A, Tombstone[A]], [A]
|
||||
|
||||
Now when we issue a repair the Tombstone will be copied to the replica, rather than the deleted data being
|
||||
resurrected.::
|
||||
|
||||
[A, Tombstone[A]], [A, Tombstone[A]], [A, Tombstone[A]]
|
||||
|
||||
Our repair operation will correctly put the state of the system to what we expect with the record [A] marked as deleted
|
||||
on all nodes. This does mean we will end up accruing Tombstones which will permanently accumulate disk space. To avoid
|
||||
keeping tombstones forever we have a parameter known as ``gc_grace_seconds`` for every table in Cassandra.
|
||||
|
||||
The gc_grace_seconds parameter and Tombstone Removal
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The table level ``gc_grace_seconds`` parameter controls how long Cassandra will retain tombstones through compaction
|
||||
events before finally removing them. This duration should directly reflect the amount of time a user expects to allow
|
||||
before recovering a failed node. After ``gc_grace_seconds`` has expired the tombstone can be removed meaning there will
|
||||
no longer be any record that a certain piece of data was deleted. This means if a node remains down or disconnected for
|
||||
longer than ``gc_grace_seconds`` it's deleted data will be repaired back to the other nodes and re-appear in the
|
||||
cluster. This is basically the same as in the "Deletes without Tombstones" section. Note that tombstones will not be
|
||||
removed until a compaction event even if ``gc_grace_seconds`` has elapsed.
|
||||
|
||||
The default value for ``gc_grace_seconds`` is 864000 which is equivalent to 10 days. This can be set when creating or
|
||||
altering a table using ``WITH gc_grace_seconds``.
|
||||
|
||||
|
||||
Bloom Filters
|
||||
-------------
|
||||
|
||||
In the read path, Cassandra merges data on disk (in SSTables) with data in RAM (in memtables). To avoid checking every
|
||||
SSTable data file for the partition being requested, Cassandra employs a data structure known as a bloom filter.
|
||||
|
||||
Bloom filters are a probabilistic data structure that allows Cassandra to determine one of two possible states: - The
|
||||
data definitely does not exist in the given file, or - The data probably exists in the given file.
|
||||
|
||||
While bloom filters can not guarantee that the data exists in a given SSTable, bloom filters can be made more accurate
|
||||
by allowing them to consume more RAM. Operators have the opportunity to tune this behavior per table by adjusting the
|
||||
the ``bloom_filter_fp_chance`` to a float between 0 and 1.
|
||||
|
||||
The default value for ``bloom_filter_fp_chance`` is 0.1 for tables using LeveledCompactionStrategy and 0.01 for all
|
||||
other cases.
|
||||
|
||||
Bloom filters are stored in RAM, but are stored offheap, so operators should not consider bloom filters when selecting
|
||||
the maximum heap size. As accuracy improves (as the ``bloom_filter_fp_chance`` gets closer to 0), memory usage
|
||||
increases non-linearly - the bloom filter for ``bloom_filter_fp_chance = 0.01`` will require about three times as much
|
||||
memory as the same table with ``bloom_filter_fp_chance = 0.1``.
|
||||
|
||||
Typical values for ``bloom_filter_fp_chance`` are usually between 0.01 (1%) to 0.1 (10%) false-positive chance, where
|
||||
Cassandra may scan an SSTable for a row, only to find that it does not exist on the disk. The parameter should be tuned
|
||||
by use case:
|
||||
|
||||
- Users with more RAM and slower disks may benefit from setting the ``bloom_filter_fp_chance`` to a numerically lower
|
||||
number (such as 0.01) to avoid excess IO operations
|
||||
- Users with less RAM, more dense nodes, or very fast disks may tolerate a higher ``bloom_filter_fp_chance`` in order to
|
||||
save RAM at the expense of excess IO operations
|
||||
- In workloads that rarely read, or that only perform reads by scanning the entire data set (such as analytics
|
||||
workloads), setting the ``bloom_filter_fp_chance`` to a much higher number is acceptable.
|
||||
|
||||
Changing
|
||||
^^^^^^^^
|
||||
|
||||
The bloom filter false positive chance is visible in the ``DESCRIBE TABLE`` output as the field
|
||||
``bloom_filter_fp_chance``. Operators can change the value with an ``ALTER TABLE`` statement:
|
||||
::
|
||||
|
||||
ALTER TABLE keyspace.table WITH bloom_filter_fp_chance=0.01
|
||||
|
||||
Operators should be aware, however, that this change is not immediate: the bloom filter is calculated when the file is
|
||||
written, and persisted on disk as the Filter component of the SSTable. Upon issuing an ``ALTER TABLE`` statement, new
|
||||
files on disk will be written with the new ``bloom_filter_fp_chance``, but existing sstables will not be modified until
|
||||
they are compacted - if an operator needs a change to ``bloom_filter_fp_chance`` to take effect, they can trigger an
|
||||
SSTable rewrite using ``nodetool scrub`` or ``nodetool upgradesstables -a``, both of which will rebuild the sstables on
|
||||
disk, regenerating the bloom filters in the progress.
|
||||
|
||||
|
||||
Compression
|
||||
-----------
|
||||
|
||||
Cassandra offers operators the ability to configure compression on a per-table basis. Compression reduces the size of
|
||||
data on disk by compressing the SSTable in user-configurable compression ``chunk_length_in_kb``. Because Cassandra
|
||||
SSTables are immutable, the CPU cost of compressing is only necessary when the SSTable is written - subsequent updates
|
||||
to data will land in different SSTables, so Cassandra will not need to decompress, overwrite, and recompress data when
|
||||
UPDATE commands are issued. On reads, Cassandra will locate the relevant compressed chunks on disk, decompress the full
|
||||
chunk, and then proceed with the remainder of the read path (merging data from disks and memtables, read repair, and so
|
||||
on).
|
||||
|
||||
Configuring Compression
|
||||
^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Compression is configured on a per-table basis as an optional argument to ``CREATE TABLE`` or ``ALTER TABLE``. By
|
||||
default, three options are relevant:
|
||||
|
||||
- ``class`` specifies the compression class - Cassandra provides three classes (``LZ4Compressor``,
|
||||
``SnappyCompressor``, and ``DeflateCompressor`` ). The default is ``SnappyCompressor``.
|
||||
- ``chunk_length_in_kb`` specifies the number of kilobytes of data per compression chunk. The default is 64KB.
|
||||
- ``crc_check_chance`` determines how likely Cassandra is to verify the checksum on each compression chunk during
|
||||
reads. The default is 1.0.
|
||||
|
||||
Users can set compression using the following syntax:
|
||||
|
||||
::
|
||||
|
||||
CREATE TABLE keyspace.table (id int PRIMARY KEY) WITH compression = {'class': 'LZ4Compressor'};
|
||||
|
||||
Or
|
||||
|
||||
::
|
||||
|
||||
ALTER TABLE keyspace.table WITH compression = {'class': 'SnappyCompressor', 'chunk_length_in_kb': 128, 'crc_check_chance': 0.5};
|
||||
|
||||
Once enabled, compression can be disabled with ``ALTER TABLE`` setting ``enabled`` to ``false``:
|
||||
|
||||
::
|
||||
|
||||
ALTER TABLE keyspace.table WITH compression = {'enabled':'false'};
|
||||
|
||||
Operators should be aware, however, that changing compression is not immediate. The data is compressed when the SSTable
|
||||
is written, and as SSTables are immutable, the compression will not be modified until the table is compacted. Upon
|
||||
issuing a change to the compression options via ``ALTER TABLE``, the existing SSTables will not be modified until they
|
||||
are compacted - if an operator needs compression changes to take effect immediately, the operator can trigger an SSTable
|
||||
rewrite using ``nodetool scrub`` or ``nodetool upgradesstables -a``, both of which will rebuild the SSTables on disk,
|
||||
re-compressing the data in the process.
|
||||
|
||||
Benefits and Uses
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
Compression's primary benefit is that it reduces the amount of data written to disk. Not only does the reduced size save
|
||||
in storage requirements, it often increases read and write throughput, as the CPU overhead of compressing data is faster
|
||||
than the time it would take to read or write the larger volume of uncompressed data from disk.
|
||||
|
||||
Compression is most useful in tables comprised of many rows, where the rows are similar in nature. Tables containing
|
||||
similar text columns (such as repeated JSON blobs) often compress very well.
|
||||
|
||||
Operational Impact
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
- Compression metadata is stored offheap and scales with data on disk. This often requires 1-3GB of offheap RAM per
|
||||
terabyte of data on disk, though the exact usage varies with ``chunk_length_in_kb`` and compression ratios.
|
||||
|
||||
- Streaming operations involve compressing and decompressing data on compressed tables - in some code paths (such as
|
||||
non-vnode bootstrap), the CPU overhead of compression can be a limiting factor.
|
||||
|
||||
- The compression path checksums data to ensure correctness - while the traditional Cassandra read path does not have a
|
||||
way to ensure correctness of data on disk, compressed tables allow the user to set ``crc_check_chance`` (a float from
|
||||
0.0 to 1.0) to allow Cassandra to probabilistically validate chunks on read to verify bits on disk are not corrupt.
|
||||
|
||||
Advanced Use
|
||||
^^^^^^^^^^^^
|
||||
|
||||
Advanced users can provide their own compression class by implementing the interface at
|
||||
``org.apache.cassandra.io.compress.ICompressor``.
|
||||
|
||||
Backups
|
||||
-------
|
||||
|
||||
.. todo:: todo
|
||||
|
||||
Monitoring
|
||||
----------
|
||||
|
||||
JMX
|
||||
^^^
|
||||
.. todo:: todo
|
||||
|
||||
Metric Reporters
|
||||
^^^^^^^^^^^^^^^^
|
||||
.. todo:: todo
|
||||
|
||||
Security
|
||||
--------
|
||||
|
||||
Roles
|
||||
^^^^^
|
||||
|
||||
.. todo:: todo
|
||||
|
||||
JMX access
|
||||
^^^^^^^^^^
|
||||
|
||||
.. todo:: todo
|
||||
|
||||
Nodetool (and other tooling)
|
||||
----------------------------
|
||||
|
||||
.. todo:: Try to autogenerate this from Nodetool’s help.
|
||||
|
||||
Hardware Choices
|
||||
----------------
|
||||
|
||||
Like most databases, Cassandra throughput improves with more CPU cores, more RAM, and faster disks. While Cassandra can
|
||||
be made to run on small servers for testing or development environments (including Raspberry Pis), a minimal production
|
||||
server requires at least 2 cores, and at least 8GB of RAM. Typical production servers have 8 or more cores and at least
|
||||
32GB of RAM.
|
||||
|
||||
CPU
|
||||
^^^
|
||||
Cassandra is highly concurrent, handling many simultaneous requests (both read and write) using multiple threads running
|
||||
on as many CPU cores as possible. The Cassandra write path tends to be heavily optimized (writing to the commitlog and
|
||||
then inserting the data into the memtable), so writes, in particular, tend to be CPU bound. Consequently, adding
|
||||
additional CPU cores often increases throughput of both reads and writes.
|
||||
|
||||
Memory
|
||||
^^^^^^
|
||||
Cassandra runs within a Java VM, which will pre-allocate a fixed size heap (java's Xmx system parameter). In addition to
|
||||
the heap, Cassandra will use significant amounts of RAM offheap for compression metadata, bloom filters, row, key, and
|
||||
counter caches, and an in process page cache. Finally, Cassandra will take advantage of the operating system's page
|
||||
cache, storing recently accessed portions files in RAM for rapid re-use.
|
||||
|
||||
For optimal performance, operators should benchmark and tune their clusters based on their individual workload. However,
|
||||
basic guidelines suggest:
|
||||
|
||||
- ECC RAM should always be used, as Cassandra has few internal safeguards to protect against bit level corruption
|
||||
- The Cassandra heap should be no less than 2GB, and no more than 50% of your system RAM
|
||||
- Heaps smaller than 12GB should consider ParNew/ConcurrentMarkSweep garbage collection
|
||||
- Heaps larger than 12GB should consider G1GC
|
||||
|
||||
Disks
|
||||
^^^^^
|
||||
Cassandra persists data to disk for two very different purposes. The first is to the commitlog when a new write is made
|
||||
so that it can be replayed after a crash or system shutdown. The second is to the data directory when thresholds are
|
||||
exceeded and memtables are flushed to disk as SSTables.
|
||||
|
||||
Commitlogs receive every write made to a Cassandra node and have the potential to block client operations, but they are
|
||||
only ever read on node start-up. SSTable (data file) writes on the other hand occur asynchronously, but are read to
|
||||
satisfy client look-ups. SSTables are also periodically merged and rewritten in a process called compaction. The data
|
||||
held in the commitlog directory is data that has not been permanently saved to the SSTable data directories - it will be
|
||||
periodically purged once it is flushed to the SSTable data files.
|
||||
|
||||
Cassandra performs very well on both spinning hard drives and solid state disks. In both cases, Cassandra's sorted
|
||||
immutable SSTables allow for linear reads, few seeks, and few overwrites, maximizing throughput for HDDs and lifespan of
|
||||
SSDs by avoiding write amplification. However, when using spinning disks, it's important that the commitlog
|
||||
(``commitlog_directory``) be on one physical disk (not simply a partition, but a physical disk), and the data files
|
||||
(``data_file_directories``) be set to a separate physical disk. By separating the commitlog from the data directory,
|
||||
writes can benefit from sequential appends to the commitlog without having to seek around the platter as reads request
|
||||
data from various SSTables on disk.
|
||||
|
||||
In most cases, Cassandra is designed to provide redundancy via multiple independent, inexpensive servers. For this
|
||||
reason, using NFS or a SAN for data directories is an antipattern and should typically be avoided. Similarly, servers
|
||||
with multiple disks are often better served by using RAID0 or JBOD than RAID1 or RAID5 - replication provided by
|
||||
Cassandra obsoletes the need for replication at the disk layer, so it's typically recommended that operators take
|
||||
advantage of the additional throughput of RAID0 rather than protecting against failures with RAID1 or RAID5.
|
||||
|
||||
Common Cloud Choices
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Many large users of Cassandra run in various clouds, including AWS, Azure, and GCE - Cassandra will happily run in any
|
||||
of these environments. Users should choose similar hardware to what would be needed in physical space. In EC2, popular
|
||||
options include:
|
||||
|
||||
- m1.xlarge instances, which provide 1.6TB of local ephemeral spinning storage and sufficient RAM to run moderate
|
||||
workloads
|
||||
- i2 instances, which provide both a high RAM:CPU ratio and local ephemeral SSDs
|
||||
- m4.2xlarge / c4.4xlarge instances, which provide modern CPUs, enhanced networking and work well with EBS GP2 (SSD)
|
||||
storage
|
||||
|
||||
Generally, disk and network performance increases with instance size and generation, so newer generations of instances
|
||||
and larger instance types within each family often perform better than their smaller or older alternatives.
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
.. Licensed to the Apache Software Foundation (ASF) under one
|
||||
.. or more contributor license agreements. See the NOTICE file
|
||||
.. distributed with this work for additional information
|
||||
.. regarding copyright ownership. The ASF licenses this file
|
||||
.. to you under the Apache License, Version 2.0 (the
|
||||
.. "License"); you may not use this file except in compliance
|
||||
.. with the License. You may obtain a copy of the License at
|
||||
..
|
||||
.. http://www.apache.org/licenses/LICENSE-2.0
|
||||
..
|
||||
.. Unless required by applicable law or agreed to in writing, software
|
||||
.. distributed under the License is distributed on an "AS IS" BASIS,
|
||||
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
.. See the License for the specific language governing permissions and
|
||||
.. limitations under the License.
|
||||
|
||||
Troubleshooting
|
||||
===============
|
||||
|
||||
.. TODO: todo
|
||||
Loading…
Reference in New Issue