Full table of contents

• Introduction
• Administration Guide
  • Run Qserv on top of Kubernetes
    • Deployment
    • Administration
      • Access to Qserv dashboard
  • The Qserv Ingest Workflow
    • Set up ingest input data
      • Prerequisites
      • Example
      • Input data
      • Metadata
    • The version history of the Ingest Workflow
      • Version numbers
      • The summary info on the versions
        • Version 12: Add mandatory version numbers in configuration files
    • Run Qserv ingest on a Kubernetes cluster
      • Prerequisites
      • Prepare and configure Qserv ingest
        • Get the project
        • Configuration
      • Launch Qserv ingest
      • Delete an existing database
      • Run interactively a workflow step
    • How to use replication service client
      • Pre-requisites
      • Procedure
    • About integration test cases
      • Integration test datasets
      • How to add an integration test case to qserv-ingest
        • Pre-requisites
        • Procedure
  • Test sets
    • Integration tests
      • Input data sets
        • Directory structure
        • Database
        • Query file format
• User Guide
  • Introduction
  • Selected Design Aspects
    • Partitioning and Sharding
    • Director Table
    • Secondary Index
  • Extensions
    • Spatial Constraints
  • Restrictions
    • Spatial constraints should be expressed through our qserv_areaspec_* functions
    • Spatial constraints must appear at the beginning of WHERE
    • Only one spatial constraint is allowed per query
    • Arguments passed to spatial constraints functions must be simple literals
    • OR is not allowed after qserv_areaspec_* constraint
    • Secondary index constraint must be expressed through “=”, “IN”, or “BETWEEN”
    • Column(s) used in ORDER BY or GROUP BY must appear in SELECT
    • Expressions/functions in ORDER BY clauses are not allowed
    • Sub-queries are NOT supported
    • Commands that modify tables are disallowed
    • Outer joins are not supported with near-neighbor queries
    • MySQL-specific syntax is not supported
    • Repeated column names through * are not supported
    • “USE INDEX()” is not supported
    • Variables are not supported
  • User Defined Functions
  • Example Queries Supported
    • Counts and simple selections
      • Count the number of rows in a table
      • Find rows with a particular id
      • Select rows in a given area
      • Select rows in a given area meeting certain criteria
      • Find a row with a particular id
    • Joins
      • Join two tables
      • Find near neighbors in a given region
    • LIMIT, ORDER BY
      • Limit results, sort results
  • Known Bugs
    • Selecting by objectId can miss a row
    • WHERE objectId BETWEEN fails
  • Notes of Performance
    • Use objectId when selecting sources
• Developer Guide
  • Quick start guide for developers
    • Bootstrap a development environment
    • Build an image for production
  • Generate documentation
  • CSS metadata layout
    • Implementation
    • Packed keys
    • CSS interface
  • Worker Manager API
    • Overview
    • General API description
      • Return codes and content types
    • Database API
      • GET /dbs
      • POST /dbs
      • DELETE /dbs/<dbName>
      • GET /dbs/<dbName>/tables
      • POST /dbs/<dbName>/tables
      • DELETE /dbs/<dbName>/tables/<tblName>
      • GET /dbs/<dbName>/tables/<tblName>/schema
      • GET /dbs/<dbName>/tables/<tblName>/columns
      • GET /dbs/<dbName>/tables/<tblName>/chunks
      • POST /dbs/<dbName>/tables/<tblName>/chunks
      • DELETE /dbs/<dbName>/tables/<tblName>/chunks/<chunkId>
      • POST /<dbName>/tables/<tblName>/data
      • POST /<dbName>/tables/<tblName>/chunks/<chunkId>/data
      • POST /<dbName>/tables/<tblName>/chunks/<chunkId>/overlap
      • GET /dbs/<dbName>/tables/<tblName>/index
      • GET /dbs/<dbName>/tables/<tblName>/chunks/<chunkId>/index
    • Xrootd API
      • GET /xrootd/dbs
      • POST /xrootd/dbs
      • DELETE /xrootd/dbs/<dbName>
      • GET /xrootd/dbs/<dbName>
    • Services API
      • GET /services
      • GET /services/<service>
      • PUT /services/<service>