sphinx_db¶
Todo
Add description
Database Schema¶
Project initialization¶
- sphinx_db.orm.ConfigVariable (config_variables)
A configuration variable in the project.
Columns:
id*
INTEGER
name*
VARCHAR
rebuild
VARCHAR?
valid_types
VARCHAR
Constraints:
PRIMARY KEY (id)
UNIQUE (name)
- sphinx_db.orm.Directive (directives)
An available directive in the project.
Columns:
id*
INTEGER
name*
VARCHAR
package
VARCHAR
required_arguments
INTEGER?
optional_arguments
INTEGER?
final_argument_whitespace
BOOLEAN?
options
JSON?
has_content
BOOLEAN?
Constraints:
PRIMARY KEY (id)
UNIQUE (name)
- sphinx_db.orm.Role (roles)
An available role in the project.
Columns:
id*
INTEGER
name*
VARCHAR
package
VARCHAR
Constraints:
PRIMARY KEY (id)
UNIQUE (name)
- sphinx_db.orm.ObjectRoles (object_roles)
A (domain, object_type, role_name) available in the project.
We need this, since reference targets are stored by object type, but they they must be referenced using a role. object_type to role is a one-to-many relationship.
Columns:
id*
INTEGER
domain
VARCHAR
object_type
VARCHAR
role
VARCHAR
Constraints:
PRIMARY KEY (id)
- sphinx_db.orm.IntersphinxTarget (intersphinx_targets)
An available intersphinx target in the project.
Columns:
id*
INTEGER
key
VARCHAR
domain
VARCHAR
object_type
VARCHAR
name
VARCHAR
dispname
VARCHAR?
url
VARCHAR
Constraints:
PRIMARY KEY (id)
Project build¶
- sphinx_db.orm.BuildWarning (build_warnings)
Warnings emitted by sphinx during the build.
Columns:
id*
INTEGER
message
VARCHAR
source
VARCHAR?
docname
VARCHAR?
line
INTEGER?
type
VARCHAR?
subtype
VARCHAR?
suppressed
BOOLEAN
once
BOOLEAN
Constraints:
PRIMARY KEY (id)
- sphinx_db.orm.DocumentTarget (doc_targets)
An available explicit target node in a document.
Columns:
id*
INTEGER
name
VARCHAR
docname
VARCHAR
line
INTEGER
Constraints:
PRIMARY KEY (id)
- sphinx_db.orm.ProjectTarget (project_targets)
An available target in the project.
Columns:
id*
INTEGER
domain
VARCHAR
object_type
VARCHAR
name
VARCHAR
dispname
VARCHAR?
docname
VARCHAR
Constraints:
PRIMARY KEY (id)