You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by ja...@apache.org on 2020/07/27 15:45:47 UTC
[couchdb-documentation] branch master updated (d685a08 -> adadae7)
This is an automated email from the ASF dual-hosted git repository.
jan pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git.
from d685a08 Added the documenation of a newly proposed Mango operator : $keyMapMatch.
new 6c46818 fix(docs): small fixes to the tour (typos etc.)
new 15e6b31 feat(docs): add note to tour about missing mango indexes
new adadae7 fix(docs): address review comments in tour update
The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
src/intro/tour.rst | 27 ++++++++++++++++++++-------
1 file changed, 20 insertions(+), 7 deletions(-)
[couchdb-documentation] 02/03: feat(docs): add note to tour about
missing mango indexes
Posted by ja...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
jan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git
commit 15e6b31bb033e745e4ba0a8fb2683059141a87ab
Author: Alex Feyerke <he...@alexfeyerke.com>
AuthorDate: Mon Jul 27 16:56:17 2020 +0200
feat(docs): add note to tour about missing mango
indexes
---
src/intro/tour.rst | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/src/intro/tour.rst b/src/intro/tour.rst
index a4517e8..6a15582 100644
--- a/src/intro/tour.rst
+++ b/src/intro/tour.rst
@@ -340,6 +340,13 @@ Then click on ”Run Query”.
The result should be a single result, the movie “My Neighbour Totoro” which
has the year value of 1988. ``$eq`` here stands for “equal”.
+Note that if you skip adding the index, the query will still return the
+correct results, although you will see a warning about not using a pre-existing
+index. Not using an index will work fine on small databases and is acceptable
+for testing out queries in development or training, but we very strongly
+discourage doing this in any other case, since an index is absolutely vital to
+good query performance.
+
You can also query for all movies during the 1980s, with this selector:
.. code-block:: javascript
[couchdb-documentation] 03/03: fix(docs): address review comments
in tour update
Posted by ja...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
jan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git
commit adadae71bf90bc14253db24cdc9d35b1b9a32b1b
Author: Alex Feyerke <he...@alexfeyerke.com>
AuthorDate: Mon Jul 27 17:37:30 2020 +0200
fix(docs): address review comments in tour update
---
src/intro/tour.rst | 19 ++++++++++++-------
1 file changed, 12 insertions(+), 7 deletions(-)
diff --git a/src/intro/tour.rst b/src/intro/tour.rst
index 6a15582..135eab8 100644
--- a/src/intro/tour.rst
+++ b/src/intro/tour.rst
@@ -340,12 +340,13 @@ Then click on ”Run Query”.
The result should be a single result, the movie “My Neighbour Totoro” which
has the year value of 1988. ``$eq`` here stands for “equal”.
-Note that if you skip adding the index, the query will still return the
-correct results, although you will see a warning about not using a pre-existing
-index. Not using an index will work fine on small databases and is acceptable
-for testing out queries in development or training, but we very strongly
-discourage doing this in any other case, since an index is absolutely vital to
-good query performance.
+.. note::
+ Note that if you skip adding the index, the query will still return the
+ correct results, although you will see a warning about not using a
+ pre-existing index. Not using an index will work fine on small databases
+ and is acceptable for testing out queries in development or training, but
+ we very strongly discourage doing this in any other case, since an index is
+ absolutely vital to good query performance.
You can also query for all movies during the 1980s, with this selector:
@@ -360,7 +361,11 @@ You can also query for all movies during the 1980s, with this selector:
}
}
-The result are the two movies from 1988 and 1989. ``$lt`` here means “lower than”, and ``$gte`` means “greater than or equal to”. The latter currently doesn’t have any effect, given that all of our movies are more recent than 1980, but this makes the query future-proof and allows us to add older movies later.
+The result are the two movies from 1988 and 1989. ``$lt`` here means “lower
+than”, and ``$gte`` means “greater than or equal to”. The latter currently
+doesn’t have any effect, given that all of our movies are more recent than
+1980, but this makes the query future-proof and allows us to add older
+movies later.
Triggering Replication
======================
[couchdb-documentation] 01/03: fix(docs): small fixes to the tour
(typos etc.)
Posted by ja...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
jan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git
commit 6c46818f9cfcf31ad0e745058c6d724a8a7dbbe9
Author: Alex Feyerke <he...@alexfeyerke.com>
AuthorDate: Mon Jul 27 16:33:50 2020 +0200
fix(docs): small fixes to the tour (typos etc.)
---
src/intro/tour.rst | 15 ++++++++-------
1 file changed, 8 insertions(+), 7 deletions(-)
diff --git a/src/intro/tour.rst b/src/intro/tour.rst
index 683af59..a4517e8 100644
--- a/src/intro/tour.rst
+++ b/src/intro/tour.rst
@@ -210,7 +210,7 @@ Your First Database and Document
================================
Creating a database in Fauxton is simple. From the overview page,
-click "Create Database." When asked for a name, enter hello-world and click
+click "Create Database." When asked for a name, enter ``hello-world`` and click
the Create button.
After your database has been created, Fauxton will display a list of all its
@@ -337,7 +337,7 @@ Next, click on “edit query” and change the Mango Query to look like this:
Then click on ”Run Query”.
-The result should be a single result, the movie “My Neighbour Toto” which
+The result should be a single result, the movie “My Neighbour Totoro” which
has the year value of 1988. ``$eq`` here stands for “equal”.
You can also query for all movies during the 1980s, with this selector:
@@ -347,12 +347,13 @@ You can also query for all movies during the 1980s, with this selector:
{
"selector": {
"year": {
- "$lt": 1990
+ "$lt": 1990,
+ "$gte": 1980
}
}
}
-The result are the two movies from 1988 and 1998. ``$lt`` here means “lower than”.
+The result are the two movies from 1988 and 1989. ``$lt`` here means “lower than”, and ``$gte`` means “greater than or equal to”. The latter currently doesn’t have any effect, given that all of our movies are more recent than 1980, but this makes the query future-proof and allows us to add older movies later.
Triggering Replication
======================
@@ -366,12 +367,12 @@ through the examples.
First we'll need to create an empty database to be the target of replication.
Return to the Databases overview and create a database called
``hello-replication``. Now click "Replication" in the sidebar and choose
-hello-world as the source and hello-replication as the target. Click
+``hello-world`` as the source and ``hello-replication`` as the target. Click
"Replicate" to replicate your database.
To view the result of your replication, click on the Databases tab again.
-You should see the hello-replication database has the same number of documents
-as the hello-world database, and it should take up roughly the same size as
+You should see the ``hello-replication`` database has the same number of documents
+as the ``hello-world`` database, and it should take up roughly the same size as
well.
.. note::