Merge branch 'cassandra-3.11' into cassandra-4.0
Mick Semb Wever
|
|
@ -53,6 +53,7 @@
|
|||
<exclude name="**/cassandra.yaml"/>
|
||||
<exclude name="**/cassandra-murmur.yaml"/>
|
||||
<exclude name="**/cassandra-seeds.yaml"/>
|
||||
<exclude NAME="**/doc/antora.yml"/>
|
||||
<exclude name="**/test/conf/cassandra.yaml"/>
|
||||
<exclude name="**/test/conf/cassandra_deprecated_parameters_names.yaml"/>
|
||||
<exclude name="**/test/conf/cassandra_encryption.yaml"/>
|
||||
|
|
@ -68,6 +69,8 @@
|
|||
<exclude name="**/tools/cqlstress-example.yaml"/>
|
||||
<exclude name="**/tools/cqlstress-insanity-example.yaml"/>
|
||||
<exclude name="**/tools/cqlstress-lwt-example.yaml"/>
|
||||
<!-- Documentation files -->
|
||||
<exclude NAME="**/doc/modules/**/*"/>
|
||||
<!-- NOTICE files -->
|
||||
<exclude NAME="**/NOTICE.md"/>
|
||||
<!-- LICENSE files -->
|
||||
|
|
|
|||
|
|
@ -69,8 +69,9 @@ Thumbs.db
|
|||
.ant_targets
|
||||
|
||||
# Generated files from the documentation
|
||||
doc/source/configuration/cassandra_config_file.rst
|
||||
doc/source/tools/nodetool
|
||||
doc/modules/cassandra/pages/configuration/cass_yaml_file.adoc
|
||||
doc/modules/cassandra/pages/tools/nodetool/
|
||||
doc/modules/cassandra/examples/TEXT/NODETOOL/
|
||||
|
||||
# Python virtual environment
|
||||
venv/
|
||||
|
|
|
|||
11
build.xml
|
|
@ -420,13 +420,14 @@
|
|||
</wikitext-to-html>
|
||||
</target>
|
||||
|
||||
<target name="gen-doc" description="Generate documentation" depends="jar" unless="ant.gen-doc.skip">
|
||||
<target name="gen-asciidoc" description="Generate dynamic asciidoc pages" depends="jar" unless="ant.gen-doc.skip">
|
||||
<exec executable="make" osfamily="unix" dir="${doc.dir}">
|
||||
<arg value="html"/>
|
||||
<arg value="gen-asciidoc"/>
|
||||
</exec>
|
||||
<exec executable="cmd" osfamily="dos" dir="${doc.dir}">
|
||||
<arg value="/c"/>
|
||||
<arg value="make.bat"/>
|
||||
</target>
|
||||
|
||||
<target name="gen-doc" description="Generate documentation" depends="gen-asciidoc,generate-cql-html" unless="ant.gen-doc.skip">
|
||||
<exec executable="make" osfamily="unix" dir="${doc.dir}">
|
||||
<arg value="html"/>
|
||||
</exec>
|
||||
</target>
|
||||
|
|
|
|||
|
|
@ -1,22 +0,0 @@
|
|||
# Dockerfile for building the Cassandra documentation.
|
||||
# If wanting to regenerate the documentation from scratch,
|
||||
# run `ant realclean` from the root directory of this project.
|
||||
|
||||
FROM python:2.7
|
||||
|
||||
WORKDIR /usr/src/code
|
||||
|
||||
RUN pip install --no-cache-dir sphinx sphinx_rtd_theme
|
||||
|
||||
RUN apt-get update && apt-get install -y software-properties-common
|
||||
|
||||
RUN wget -qO - https://adoptopenjdk.jfrog.io/adoptopenjdk/api/gpg/key/public | apt-key add - \
|
||||
&& add-apt-repository --yes https://adoptopenjdk.jfrog.io/adoptopenjdk/deb/ \
|
||||
&& apt-get update \
|
||||
&& apt-get install -y adoptopenjdk-11-hotspot ant
|
||||
|
||||
|
||||
RUN apt-get clean
|
||||
|
||||
CMD CASSANDRA_USE_JDK11=true ant realclean gen-doc \
|
||||
&& echo "The locally built documentation can be found here:\n\n build/html/index.html\n\n"
|
||||
312
doc/Makefile
|
|
@ -1,296 +1,26 @@
|
|||
# Makefile for Sphinx documentation
|
||||
#
|
||||
# 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.
|
||||
|
||||
# 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
|
||||
|
||||
YAML_DOC_INPUT=../conf/cassandra.yaml
|
||||
YAML_DOC_OUTPUT=source/configuration/cassandra_config_file.rst
|
||||
|
||||
MAKE_CASSANDRA_YAML = python convert_yaml_to_rst.py $(YAML_DOC_INPUT) $(YAML_DOC_OUTPUT)
|
||||
|
||||
GENERATE_NODETOOL_DOCS = python gen-nodetool-docs.py
|
||||
|
||||
WEB_SITE_PRESENCE_FILE='source/.build_for_website'
|
||||
|
||||
.PHONY: help
|
||||
help:
|
||||
@echo "Please use \`make <target>' where <target> is one of"
|
||||
@echo " html to make standalone HTML files"
|
||||
@echo " website to make HTML files for the Cassandra website"
|
||||
@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)/*
|
||||
rm -f $(YAML_DOC_OUTPUT)
|
||||
GENERATE_NODETOOL_DOCS = ./scripts/gen-nodetool-docs.py
|
||||
MAKE_CASSANDRA_YAML = ./scripts/convert_yaml_to_adoc.py ../conf/cassandra.yaml ./modules/cassandra/pages/configuration/cass_yaml_file.adoc
|
||||
|
||||
.PHONY: html
|
||||
html:
|
||||
$(MAKE_CASSANDRA_YAML)
|
||||
$(GENERATE_NODETOOL_DOCS)
|
||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||||
@# hack until a local basic antora build is put in
|
||||
|
||||
.PHONY: website
|
||||
website: clean
|
||||
@touch $(WEB_SITE_PRESENCE_FILE)
|
||||
$(MAKE_CASSANDRA_YAML)
|
||||
$(GENERATE_NODETOOL_DOCS)
|
||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||
@rm $(WEB_SITE_PRESENCE_FILE)
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||||
|
||||
.PHONY: dirhtml
|
||||
dirhtml:
|
||||
$(MAKE_CASSANDRA_YAML)
|
||||
$(GENERATE_NODETOOL_DOCS)
|
||||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
||||
|
||||
.PHONY: singlehtml
|
||||
singlehtml:
|
||||
$(MAKE_CASSANDRA_YAML)
|
||||
$(GENERATE_NODETOOL_DOCS)
|
||||
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
||||
|
||||
.PHONY: pickle
|
||||
pickle:
|
||||
$(MAKE_CASSANDRA_YAML)
|
||||
$(GENERATE_NODETOOL_DOCS)
|
||||
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
||||
@echo
|
||||
@echo "Build finished; now you can process the pickle files."
|
||||
|
||||
.PHONY: json
|
||||
json:
|
||||
$(MAKE_CASSANDRA_YAML)
|
||||
$(GENERATE_NODETOOL_DOCS)
|
||||
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
||||
@echo
|
||||
@echo "Build finished; now you can process the JSON files."
|
||||
|
||||
.PHONY: htmlhelp
|
||||
htmlhelp:
|
||||
$(MAKE_CASSANDRA_YAML)
|
||||
$(GENERATE_NODETOOL_DOCS)
|
||||
$(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:
|
||||
$(MAKE_CASSANDRA_YAML)
|
||||
$(GENERATE_NODETOOL_DOCS)
|
||||
$(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:
|
||||
$(MAKE_CASSANDRA_YAML)
|
||||
$(GENERATE_NODETOOL_DOCS)
|
||||
$(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:
|
||||
$(MAKE_CASSANDRA_YAML)
|
||||
$(GENERATE_NODETOOL_DOCS)
|
||||
$(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:
|
||||
$(MAKE_CASSANDRA_YAML)
|
||||
$(GENERATE_NODETOOL_DOCS)
|
||||
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
||||
@echo
|
||||
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
||||
|
||||
.PHONY: epub3
|
||||
epub3:
|
||||
$(MAKE_CASSANDRA_YAML)
|
||||
$(GENERATE_NODETOOL_DOCS)
|
||||
$(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
|
||||
@echo
|
||||
@echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
|
||||
|
||||
.PHONY: latex
|
||||
latex:
|
||||
$(MAKE_CASSANDRA_YAML)
|
||||
$(GENERATE_NODETOOL_DOCS)
|
||||
$(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:
|
||||
$(MAKE_CASSANDRA_YAML)
|
||||
$(GENERATE_NODETOOL_DOCS)
|
||||
$(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:
|
||||
$(MAKE_CASSANDRA_YAML)
|
||||
$(GENERATE_NODETOOL_DOCS)
|
||||
$(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:
|
||||
$(MAKE_CASSANDRA_YAML)
|
||||
$(GENERATE_NODETOOL_DOCS)
|
||||
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
||||
@echo
|
||||
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
||||
|
||||
.PHONY: texinfo
|
||||
texinfo:
|
||||
$(MAKE_CASSANDRA_YAML)
|
||||
$(GENERATE_NODETOOL_DOCS)
|
||||
$(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:
|
||||
$(MAKE_CASSANDRA_YAML)
|
||||
$(GENERATE_NODETOOL_DOCS)
|
||||
$(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:
|
||||
$(MAKE_CASSANDRA_YAML)
|
||||
$(GENERATE_NODETOOL_DOCS)
|
||||
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
||||
@echo
|
||||
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
||||
|
||||
.PHONY: changes
|
||||
changes:
|
||||
$(MAKE_CASSANDRA_YAML)
|
||||
$(GENERATE_NODETOOL_DOCS)
|
||||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
||||
@echo
|
||||
@echo "The overview file is in $(BUILDDIR)/changes."
|
||||
|
||||
.PHONY: linkcheck
|
||||
linkcheck:
|
||||
$(MAKE_CASSANDRA_YAML)
|
||||
$(GENERATE_NODETOOL_DOCS)
|
||||
$(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:
|
||||
$(MAKE_CASSANDRA_YAML)
|
||||
$(GENERATE_NODETOOL_DOCS)
|
||||
$(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:
|
||||
$(MAKE_CASSANDRA_YAML)
|
||||
$(GENERATE_NODETOOL_DOCS)
|
||||
$(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:
|
||||
$(MAKE_CASSANDRA_YAML)
|
||||
$(GENERATE_NODETOOL_DOCS)
|
||||
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
|
||||
@echo
|
||||
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
|
||||
|
||||
.PHONY: pseudoxml
|
||||
pseudoxml:
|
||||
$(MAKE_CASSANDRA_YAML)
|
||||
$(GENERATE_NODETOOL_DOCS)
|
||||
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
|
||||
@echo
|
||||
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
|
||||
|
||||
.PHONY: dummy
|
||||
dummy:
|
||||
$(MAKE_CASSANDRA_YAML)
|
||||
$(GENERATE_NODETOOL_DOCS)
|
||||
$(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
|
||||
@echo
|
||||
@echo "Build finished. Dummy builder generates no files."
|
||||
.PHONY: gen-asciidoc
|
||||
gen-asciidoc:
|
||||
@mkdir -p modules/cassandra/pages/tools/nodetool
|
||||
@mkdir -p modules/cassandra/examples/TEXT/NODETOOL
|
||||
python3 $(GENERATE_NODETOOL_DOCS)
|
||||
python3 $(MAKE_CASSANDRA_YAML)
|
||||
|
|
|
|||
|
|
@ -23,52 +23,39 @@ 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/`
|
||||
- The source of the official Cassandra documentation, in the `source/modules`
|
||||
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).
|
||||
the `modules/cassandra/pages` subdirectory. The documentation uses [antora](http://www.antora.org/)
|
||||
and is thus written in [asciidoc](http://asciidoc.org).
|
||||
|
||||
To build the HTML documentation, you will need to first install sphinx and the
|
||||
[sphinx ReadTheDocs theme](https://pypi.org/project/sphinx_rtd_theme/).
|
||||
When using Python 3.6 on Windows, use `py -m pip install sphinx sphinx_rtd_theme`, on unix
|
||||
use:
|
||||
To generate the asciidoc files for cassandra.yaml and the nodetool commands, run (from project root):
|
||||
```bash
|
||||
ant gen-asciidoc
|
||||
```
|
||||
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. When using Python 3.6 on Windows, use `sphinx_build -b html source build`.
|
||||
|
||||
To build the documentation with Docker Compose, run:
|
||||
or (from this directory):
|
||||
|
||||
```bash
|
||||
cd ./doc
|
||||
|
||||
# build the Docker image
|
||||
docker-compose build build-docs
|
||||
|
||||
# build the documentation
|
||||
docker-compose run build-docs
|
||||
make gen-asciidoc
|
||||
```
|
||||
|
||||
To regenerate the documentation from scratch, run:
|
||||
|
||||
(The following has not yet been implemented, for now see the build instructions in the [cassandra-website](https://github.com/apache/cassandra-website) repo.)
|
||||
To build the documentation, run (from project root):
|
||||
|
||||
```bash
|
||||
# return to the root directory of the Cassandra project
|
||||
cd ..
|
||||
|
||||
# remove all generated documentation files based on the source code
|
||||
ant realclean
|
||||
ant gen-doc
|
||||
```
|
||||
or (from this directory):
|
||||
|
||||
```bash
|
||||
make html
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,9 @@
|
|||
name: Cassandra
|
||||
version: '4.0'
|
||||
display_version: '4.0'
|
||||
asciidoc:
|
||||
attributes:
|
||||
cass_url: 'http://cassandra.apache.org/'
|
||||
nav:
|
||||
- modules/ROOT/nav.adoc
|
||||
- modules/cassandra/nav.adoc
|
||||
|
|
@ -1,29 +0,0 @@
|
|||
#
|
||||
# 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.
|
||||
#
|
||||
|
||||
# docker-compose.yml for building the Cassandra documentation.
|
||||
|
||||
version: '2.0'
|
||||
|
||||
services:
|
||||
build-docs:
|
||||
build: .
|
||||
volumes:
|
||||
- ..:/usr/src/code
|
||||
environment:
|
||||
- SKIP_NODETOOL # set this to skip nodetool build, saves a lot of time when debugging html
|
||||
299
doc/make.bat
|
|
@ -1,299 +0,0 @@
|
|||
@ECHO OFF
|
||||
|
||||
REM
|
||||
REM Licensed to the Apache Software Foundation (ASF) under one
|
||||
REM or more contributor license agreements. See the NOTICE file
|
||||
REM distributed with this work for additional information
|
||||
REM regarding copyright ownership. The ASF licenses this file
|
||||
REM to you under the Apache License, Version 2.0 (the
|
||||
REM "License"); you may not use this file except in compliance
|
||||
REM with the License. You may obtain a copy of the License at
|
||||
REM
|
||||
REM http://www.apache.org/licenses/LICENSE-2.0
|
||||
REM
|
||||
REM Unless required by applicable law or agreed to in writing, software
|
||||
REM distributed under the License is distributed on an "AS IS" BASIS,
|
||||
REM WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
REM See the License for the specific language governing permissions and
|
||||
REM limitations under the License.
|
||||
REM
|
||||
|
||||
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,4 @@
|
|||
* xref:index.adoc[Main]
|
||||
** xref:master@_:ROOT:glossary.adoc[Glossary]
|
||||
** xref:master@_:ROOT:bugs.adoc[How to report bugs]
|
||||
** xref:master@_:ROOT:contactus.adoc[Contact us]
|
||||
|
|
@ -0,0 +1,50 @@
|
|||
= Welcome to Apache Cassandra's documentation!
|
||||
|
||||
:description: Starting page for Apache Cassandra documentation.
|
||||
:keywords: Apache, Cassandra, NoSQL, database
|
||||
:cass-url: http://cassandra.apache.org
|
||||
:cass-contrib-url: https://wiki.apache.org/cassandra/HowToContribute
|
||||
|
||||
This is the official documentation for {cass-url}[Apache Cassandra].
|
||||
If you would like to contribute to this documentation, you are welcome
|
||||
to do so by submitting your contribution like any other patch following
|
||||
{cass-contrib-url}[these instructions].
|
||||
|
||||
== Main documentation
|
||||
|
||||
[cols="a,a"]
|
||||
|===
|
||||
|
||||
| xref:cassandra:getting_started/index.adoc[Getting started] | Newbie starting point
|
||||
|
||||
| xref:cassandra:new/index.adoc[What's new in 4.0] | What's new in Cassandra 4.0
|
||||
|
||||
| xref:cassandra:architecture/index.adoc[Architecture] | Cassandra's big picture
|
||||
|
||||
| xref:cassandra:data_modeling/index.adoc[Data modeling] | Hint: it's not relational
|
||||
|
||||
| xref:cassandra:cql/index.adoc[Cassandra Query Language (CQL)] | CQL reference documentation
|
||||
|
||||
| xref:cassandra:configuration/index.adoc[Configuration] | Cassandra's handles and knobs
|
||||
|
||||
| xref:cassandra:operating/index.adoc[Operation] | The operator's corner
|
||||
|
||||
| xref:cassandra:tools/index.adoc[Tools] | cqlsh, nodetool, and others
|
||||
|
||||
| xref:cassandra:troubleshooting/index.adoc[Troubleshooting] | What to look for when you have a problem
|
||||
|
||||
| xref:cassandra:faq/index.adoc[FAQ] | Frequently asked questions
|
||||
|
||||
| xref:cassandra:plugins/index.adoc[Plug-ins] | Third-party plug-ins
|
||||
|
||||
| xref:master@_:ROOT:native_protocol.adoc[Native Protocols] | Native Cassandra protocol specifications
|
||||
|
||||
|===
|
||||
|
||||
== Meta information
|
||||
* xref:master@_:ROOT:bugs.adoc[Reporting bugs]
|
||||
* xref:master@_:ROOT:contactus.adoc[Contact us]
|
||||
* xref:master@_:ROOT:development/index.adoc[Contributing code]
|
||||
* xref:master@_:ROOT:docdev/index.adoc[Contributing to the docs]
|
||||
* xref:master@_:ROOT:community.adoc[Community]
|
||||
* xref:master@_:ROOT:download.adoc[Download]
|
||||
|
Before Width: | Height: | Size: 38 KiB After Width: | Height: | Size: 38 KiB |
|
Before Width: | Height: | Size: 17 KiB After Width: | Height: | Size: 17 KiB |
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
|
Before Width: | Height: | Size: 36 KiB After Width: | Height: | Size: 36 KiB |
|
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
|
Before Width: | Height: | Size: 44 KiB After Width: | Height: | Size: 44 KiB |
|
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 42 KiB |
|
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 42 KiB |
|
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 42 KiB |
|
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 56 KiB |
|
Before Width: | Height: | Size: 85 KiB After Width: | Height: | Size: 85 KiB |
|
Before Width: | Height: | Size: 4.3 MiB After Width: | Height: | Size: 4.3 MiB |
|
Before Width: | Height: | Size: 22 KiB After Width: | Height: | Size: 22 KiB |
|
Before Width: | Height: | Size: 228 KiB After Width: | Height: | Size: 228 KiB |
|
Before Width: | Height: | Size: 114 KiB After Width: | Height: | Size: 114 KiB |
|
Before Width: | Height: | Size: 117 KiB After Width: | Height: | Size: 117 KiB |
|
Before Width: | Height: | Size: 102 KiB After Width: | Height: | Size: 102 KiB |
|
Before Width: | Height: | Size: 100 KiB After Width: | Height: | Size: 100 KiB |
|
Before Width: | Height: | Size: 119 KiB After Width: | Height: | Size: 119 KiB |
|
Before Width: | Height: | Size: 139 KiB After Width: | Height: | Size: 139 KiB |
|
Before Width: | Height: | Size: 102 KiB After Width: | Height: | Size: 102 KiB |
|
Before Width: | Height: | Size: 178 KiB After Width: | Height: | Size: 178 KiB |
|
Before Width: | Height: | Size: 204 KiB After Width: | Height: | Size: 204 KiB |
|
Before Width: | Height: | Size: 104 KiB After Width: | Height: | Size: 104 KiB |
|
Before Width: | Height: | Size: 74 KiB After Width: | Height: | Size: 74 KiB |
|
Before Width: | Height: | Size: 152 KiB After Width: | Height: | Size: 152 KiB |
|
Before Width: | Height: | Size: 121 KiB After Width: | Height: | Size: 121 KiB |
|
Before Width: | Height: | Size: 47 KiB After Width: | Height: | Size: 47 KiB |
|
Before Width: | Height: | Size: 34 KiB After Width: | Height: | Size: 34 KiB |
|
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 56 KiB |
|
Before Width: | Height: | Size: 57 KiB After Width: | Height: | Size: 57 KiB |
|
Before Width: | Height: | Size: 24 KiB After Width: | Height: | Size: 24 KiB |
|
Before Width: | Height: | Size: 65 KiB After Width: | Height: | Size: 65 KiB |
|
Before Width: | Height: | Size: 86 KiB After Width: | Height: | Size: 86 KiB |
|
Before Width: | Height: | Size: 351 KiB After Width: | Height: | Size: 351 KiB |
|
|
@ -0,0 +1 @@
|
|||
$ curl https://www.apache.org/dist/cassandra/KEYS | sudo apt-key add -
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ sudo apt-get install cassandra
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ sudo apt-get update
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ cd ./cassandra/data/data/cqlkeyspace/t-d132e240c21711e9bbee19821dcea330/backups && ls -l
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ bin/cqlsh localhost
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ curl -OL http://apache.mirror.digitalpacific.com.au/cassandra/4.0.0/apache-cassandra-4.0.0-bin.tar.gz
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ curl -L https://downloads.apache.org/cassandra/4.0.0/apache-cassandra-4.0.0-bin.tar.gz.sha256
|
||||
|
|
@ -0,0 +1 @@
|
|||
docker exec -it cass_cluster cqlsh
|
||||
|
|
@ -0,0 +1 @@
|
|||
docker pull cassandra:latest
|
||||
|
|
@ -0,0 +1 @@
|
|||
docker run --name cass_cluster cassandra:latest
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ find -name backups
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ find -name snapshots
|
||||
|
|
@ -0,0 +1 @@
|
|||
find /var/lib/cassandra/data/ -type f | grep -v -- -ib- | grep -v "/snapshots"
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ cd ./cassandra/data/data/catalogkeyspace/journal-296a2d30c22a11e9b1350d927649052c/snapshots && ls -l
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
$ nodetool flush cqlkeyspace t
|
||||
$ cd ./cassandra/data/data/cqlkeyspace/t-d132e240c21711e9bbee19821dcea330/backups && ls -l
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
$ echo "deb http://www.apache.org/dist/cassandra/debian 40x main" | sudo tee -a /etc/apt/sources.list.d/cassandra.sources.list
|
||||
deb http://www.apache.org/dist/cassandra/debian 40x main
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ java -version
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ nodetool clearsnapshot -t magazine cqlkeyspace
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ nodetool clearsnapshot -all cqlkeyspace
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
$ nodetool flush cqlkeyspace t
|
||||
$ nodetool flush cqlkeyspace t2
|
||||
$ nodetool flush catalogkeyspace journal magazine
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ nodetool flush cqlkeyspace t
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ nodetool listsnapshots
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ nodetool help snapshot
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ bin/nodetool status
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ nodetool status
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ bin/cqlsh
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ cqlsh
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ nodetool snapshot --tag catalog-ks catalogkeyspace
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ nodetool snapshot --tag catalog-cql-ks catalogkeyspace, cqlkeyspace
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ cd catalog-ks && ls -l
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ nodetool snapshot --kt-list catalogkeyspace.journal,cqlkeyspace.t --tag multi-ks
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ nodetool snapshot --kt-list cqlkeyspace.t,cqlkeyspace.t2 --tag multi-table
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ nodetool snapshot --kt-list cqlkeyspace.t, cqlkeyspace.t2 --tag multi-table-2
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ nodetool snapshot --tag <tag> --table <table> --<keyspace>
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ nodetool snapshot --tag magazine --table magazine catalogkeyspace
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ cd apache-cassandra-4.0.0/ && bin/cassandra
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ tail -f logs/system.log
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ tail -f /var/log/cassandra/system.log
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ tar xzvf apache-cassandra-4.0.0-bin.tar.gz
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ gpg --print-md SHA256 apache-cassandra-4.0.0-bin.tar.gz
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ sudo yum install cassandra
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ sudo service cassandra start
|
||||
|
|
@ -0,0 +1 @@
|
|||
$ sudo yum update
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
alter_keyspace_statement::= ALTER KEYSPACE keyspace_name
|
||||
WITH options
|
||||
|
|
@ -0,0 +1 @@
|
|||
alter_materialized_view_statement::= ALTER MATERIALIZED VIEW view_name WITH table_options
|
||||
|
|
@ -0,0 +1 @@
|
|||
alter_role_statement ::= ALTER ROLE role_name WITH role_options
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
alter_table_statement::= ALTER TABLE table_name alter_table_instruction
|
||||
alter_table_instruction::= ADD column_name cql_type ( ',' column_name cql_type )*
|
||||
| DROP column_name ( column_name )*
|
||||
| WITH options
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
alter_type_statement::= ALTER TYPE udt_name alter_type_modification
|
||||
alter_type_modification::= ADD field_definition
|
||||
| RENAME identifier TO identifier( identifier TO identifier )*
|
||||
|
|
@ -0,0 +1 @@
|
|||
alter_user_statement ::= ALTER USER role_name [ WITH PASSWORD string] [ user_option]
|
||||