Skip to content

Commit

Permalink
squash w/ 264
Browse files Browse the repository at this point in the history
  • Loading branch information
korydraughn committed Aug 26, 2024
1 parent 45fb196 commit daa3f4d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions docs/system_overview/genquery.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ GenQuery is the SQL-like syntax used to query the iRODS catalog. It is used thro

This page describes syntax for **GenQuery** because it has existed for almost as long as iRODS has existed and is used extensively throughout existing iRODS clients and servers. A more modern solution is now available in the iRODS server called [**GenQuery2**](#genquery2) which will eventually replace the legacy GenQuery implementation.

## GenQuery1 Syntax
## GenQuery1

### Selection syntax

Expand Down Expand Up @@ -170,7 +170,7 @@ There are a few other options that can be used with GenQuery to affect how the r
- no-distinct: Instructs GenQuery to return all results, even repeating identical results where applicable.
- uppercase: When specified, all VALUEs should be supplied in UPPERCASE and the query will be made case-insensitive.

## GenQuery1 Attributes
### Attributes

GenQuery attributes can be used in concert to retrieve information about an entity or category of entities from multiple different tables. If the attributes are not related in some way that will allow for table joinery, an error will occur, so make sure the query makes logical sense. Attempting a query where the selected ATTRIBUTEs cannot be logically linked together will result in the error `CAT_FAILED_TO_LINK_TABLES` (iRODS error code -825000). If this problem occurs, consider splitting the query into multiple queries or finding another ATTRIBUTE which will accomplish the task.

Expand Down Expand Up @@ -507,7 +507,7 @@ Here is the complete list of GenQuery attributes available for use anywhere an A
- ZONE_NAME
- ZONE_TYPE

## Example Queries
### Example Queries

Here is a list of example GenQueries for a variety of situations to demonstrate the different ways it can be used. These are also listed in the help text for `iquest`.

Expand Down Expand Up @@ -561,7 +561,7 @@ This section will cover the differences between GenQuery1 and GenQuery2.
!!! Note
GenQuery2 is experimental and may change based on user feedback. However, we encourage its use and welcome all feedback.

### Attribute Names
### Attributes

GenQuery2 supports a subset of the GenQuery1 attributes. Some of the attributes have been renamed to better express their intent.

Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ site_dir: site
docs_dir: docs
theme:
name: readthedocs
navigation_depth: 3
navigation_depth: 4
analytics:
gtag: G-VYE9MFYWBG
extra_css:
Expand Down

0 comments on commit daa3f4d

Please sign in to comment.