DM-46111: Refactor and extend the documentation in the Qserv documentation tree #874
Conversation
iagaponenko
force-pushed
the
tickets/DM-46111
branch
5 times, most recently
from
71566f6
to
0490bec
Compare
iagaponenko
force-pushed
the
tickets/DM-46111
branch
2 times, most recently
from
5c1de47
to
0271786
Compare
There was a problem hiding this comment.
Looks good, just minor comments.
There's a file with the heading "Secondary Index" which is probably out of date. There's at least one page with a head of "Director Index", so that should probably be sorted out.
Looking at this, it would be nice if there was a way to have it print the contents of a text link instead of the link for the hints and notes. Some duplicate text could be removed.
It looks like this may be possible with ".. include:: other_page.rst"
|
|
||
| The families are defined by the Replication/Ingest system and are not visible to Qserv users. Each family has a unique | ||
| identifier (name). The system uses family names to correctly distribute the data of partitioned tables among Qserv worker | ||
| nodes, ensuring that the data of tables joined in queries are co-located on the same worker node. |
There was a problem hiding this comment.
It may be a good idea to make a mechanism so qserv users can get lists of families.
There was a problem hiding this comment.
This information is available via the following REST service of the Master Replication Controller:
GET /replication/config
Families are important mostly for the database administrators and those in charge of ingesting catalogs into Qserv. Exposing families via the SQL interface may be a bit tricky.
- Minor changes in the front page layout - Eliminated obsolete documents in all sections - Added the User's Guide for the asynchronous query interface - Added the User's Guide for the HTTP frontend - Updated Qserv Developer's Guide - Added notes for building the sciSQL library for Qserv containers - Added Administrator's guide on (re-)building the "director" indexes - Added Administrator's guide on (re-)building indexes on the data tables at workers - Added the Ingest Workflow Developer's Guide
iagaponenko
force-pushed
the
tickets/DM-46111
branch
from
0271786
to
dff5ded
Compare
No description provided.