Uploaded image for project: 'Couchbase Documentation'
  1. Couchbase Documentation
  2. DOC-11061

Update Analytics docs after review of staging

    XMLWordPrintable

Details

    • Analytics Sprint 19, Analytics Sprint 20
    • 0

    Description

      When we say things like:

      Example

      The following example turns the cost-based optimizer off.

      SET `compiler.cbo` "false";
      

      We should probably remind the reader that the SET statement applies just to the current query - always in Analytics - it doesn’t tell the server to turn off CBO and leave it off. (Minor nit, I know.)

      And the term “keyspace” AFAIK is not generally used in Analytics. (Related to the part about hints.) A different word would be nice.

      It’s basically the name in the FROM clause (the user-provided alias or the system-provided one if the user hasn’t used one).

      In general the new docs look very nice! My only other comment is that it would be nice for there to be a big flag waving at the entrance to CBAS-land that announces the arrival of CBO and leads users to this section of the docs…..

      WAIT! I found a bug. Here is one instance:

      SELECT c.*
      FROM customers c, nations n
      WHERE c.nationkey /*+ productivity s 600.0 */ = s.nationkey;
      

      The aliases are c and n but the hint says s instead of n. We need to make sure the examples all run and do what they say - this one would fail that check.

      There is also a problem with the left sidebar on the Analytics vs. Query page - the ++’s after SQL are missing.

      Should the ANALYZE stuff also be added to the DDL section of the reference?

      We should use something that's nicer than ASCII art (Graphviz?), but do that in a later patch.

      Attachments

        For Gerrit Dashboard: DOC-11061
        # Subject Branch Project Status CR V

        Activity

          People

            simon.dew Simon Dew
            simon.dew Simon Dew
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes

                PagerDuty