Add index directives for keywords, symbols, sql equivalents, etc. in docs

Author: jaclarke

docs/datamodel/access_policies.rst

@@ -6,6 +6,9 @@
 Access Policies
 ===============
 
+.. index:: access policy, object-level security, row-level security, RLS,
+           allow, deny, using
+
 Object types can contain security policies that restrict the set of objects
 that can be selected, inserted, updated, or deleted by a particular query.
 This is known as *object-level security* and it is similar in function to SQL's
@@ -378,6 +381,9 @@ is visible to a particular query.
 Policy types
 ^^^^^^^^^^^^
 
+.. index:: accesss policy, select, insert, delete, update, update read,
+           update write, all
+
 For the most part, the policy types correspond to EdgeQL's *statement types*:
 
 - ``select``: Applies to all queries; objects without a ``select`` permission
@@ -523,6 +529,8 @@ Custom error messages
 
 .. versionadded:: 3.0
 
+.. index:: access policy, errmessage, using
+
 When you run a query that attempts a write and is restricted by an access
 policy, you will get a generic error message.
 
@@ -583,6 +591,8 @@ will receive this error:
 Disabling policies
 ^^^^^^^^^^^^^^^^^^
 
+.. index:: apply_access_policies
+
 You may disable all access policies by setting the ``apply_access_policies``
 :ref:`configuration parameter <ref_std_cfg>` to ``false``.
 

docs/datamodel/aliases.rst

@@ -4,6 +4,8 @@
 Aliases
 =======
 
+.. index:: alias, virtual type
+
 .. important::
 
   This section assumes a basic understanding of EdgeQL. If you aren't familiar

docs/datamodel/annotations.rst

@@ -4,6 +4,8 @@
 Annotations
 ===========
 
+.. index:: annotation, title, description, deprecated
+
 *Annotations* are named values associated with schema items and
 are designed to hold arbitrary schema-level metadata represented as a
 :eql:type:`str`.
@@ -52,6 +54,8 @@ should be used instead.
 User-defined annotations
 ------------------------
 
+.. index:: abstract annotation
+
 To declare a custom annotation type beyond the three built-ins, add an abstract
 annotation type to your schema. A custom annotation could be used to attach
 arbitrary JSON-encoded data to your schema—potentially useful for introspection

docs/datamodel/computeds.rst

@@ -6,6 +6,8 @@ Computeds
 
 :edb-alt-title: Computed properties and links
 
+.. index:: computeds, :=, __source__, backlinks
+
 .. important::
 
   This section assumes a basic understanding of EdgeQL. If you aren't familiar

docs/datamodel/constraints.rst

@@ -4,6 +4,10 @@
 Constraints
 ===========
 
+.. index:: constraint, validation, exclusive, expression on, one_of, max_value,
+           max_ex_value, min_value, min_ex_value, max_len_value, min_len_value,
+           regexp, __subject__
+
 .. important::
 
   This section assumes a basic understanding of EdgeQL.
@@ -202,6 +206,8 @@ Constraints can be defined on computed properties.
 Composite constraints
 ^^^^^^^^^^^^^^^^^^^^^
 
+.. index:: tuple
+
 To define a composite constraint, create an ``exclusive`` constraint on a
 tuple of properties or links.
 
@@ -239,6 +245,8 @@ Partial constraints
 
 .. versionadded:: 2.0
 
+.. index:: constraint exclusive on, except
+
 Constraints on object types can be made partial, so that they don't apply
 when some condition holds.
 
@@ -333,6 +341,8 @@ Link ``@source`` and ``@target`` constraints
 
 .. versionadded:: 4.0
 
+.. index:: constraint exclusive on, @source, @target
+
 .. note::
 
     ``@source`` and ``@target`` are available starting with version 4.3.
@@ -412,6 +422,8 @@ using arbitrary EdgeQL expressions. The example below uses the built-in
 Constraints and type inheritence
 --------------------------------
 
+.. index:: delegated constraint
+
 If you define a constraint on a type and then extend that type, the constraint
 will *not* be applied individually to each extending type. Instead, it will
 apply globally across all the types that inherited the constraint.

docs/datamodel/extensions.rst

@@ -4,13 +4,18 @@
 Extensions
 ==========
 
+.. index:: using extension
+
 Extensions are the way EdgeDB adds more functionality. In principle,
 extensions could add new types, scalars, functions, etc., but, more
 importantly, they can add new ways of interacting with the database.
 
 Built-in extensions
 -------------------
 
+.. index:: edgeql_http, graphql, auth, ai, pg_trgm, pg_unaccent, pgcrypto,
+           pgvector
+
 There are a few built-in extensions available:
 
 - ``edgeql_http``: enables :ref:`EdgeQL over HTTP <ref_edgeql_http>`,
@@ -43,6 +48,8 @@ To enable these extensions, add a ``using`` statement at the top level of your s
 Standalone extensions
 ---------------------
 
+.. index:: postgis
+
 Additionally, standalone extension packages can be installed via the CLI.
 
 List installed extensions:

docs/datamodel/functions.rst

@@ -4,6 +4,8 @@
 Functions
 =========
 
+.. index:: function, using
+
 .. note::
 
   This page documents how to define custom functions, however EdgeDB provides a

docs/datamodel/future.rst

@@ -4,6 +4,8 @@
 Future Behavior
 ===============
 
+.. index:: future, nonrecursive_access_policies
+
 Any time that we add new functionality to EdgeDB we strive to do it in the
 least disruptive way possible. Deprecation warnings, documentation and guides
 can help make these transitions smoother, but sometimes the changes are just

docs/datamodel/globals.rst

@@ -6,6 +6,8 @@
 Globals
 =======
 
+.. index:: global, required global
+
 Schemas can contain scalar-typed *global variables*.
 
 .. code-block:: sdl
@@ -151,6 +153,8 @@ default value.
 Computed globals
 ----------------
 
+.. index:: global, :=
+
 Global variables can also be computed. The value of computed globals are
 dynamically computed when they are referenced in queries.
 

docs/datamodel/indexes.rst

@@ -4,6 +4,8 @@
 Indexes
 =======
 
+.. index:: index on, performance, postgres query planner
+
 An index is a data structure used internally to speed up filtering, ordering,
 and grouping operations. Indexes help accomplish this in two key ways:
 
@@ -100,6 +102,8 @@ references multiple properties of the enclosing object type.
 Index on multiple properties
 ----------------------------
 
+.. index:: tuple
+
 A *composite index* is an index that references multiple properties. This can
 speed up queries that filter, order, or group on both properties.
 
@@ -137,6 +141,8 @@ In EdgeDB, this index is created by indexing on a ``tuple`` of properties.
 Index on a link property
 ------------------------
 
+.. index:: __subject__, linkprops
+
 Link properties can also be indexed.
 
 .. code-block:: sdl
@@ -168,6 +174,8 @@ Link properties can also be indexed.
 Specify a Postgres index type
 -----------------------------
 
+.. index:: pg::hash, pg::btree, pg::gin, pg::gist, pg::spgist, pg::brin
+
 .. versionadded:: 3.0
 
 EdgeDB exposes Postgres indexes that you can use in your schemas. These are
@@ -201,6 +209,8 @@ You can use them like this:
 Annotate an index
 -----------------
 
+.. index:: annotation
+
 Indexes can be augmented with annotations.
 
 .. code-block:: sdl