docs update

This commit is contained in:
jackfoxy 2024-02-02 20:21:21 -08:00
parent 1ade8b18d8
commit 0b6e79be6d
5 changed files with 9 additions and 8 deletions

View File

@ -305,6 +305,8 @@ Schema timestamp (labelled 'system time')
Content timestamp (labelled 'data time'), if the table was populated
Row count (when table was populated)
### Exceptions
table must be dropped by local agent

View File

@ -1,5 +1,4 @@
# TRUNCATE TABLE
*supported in urQL parser, not yet supported in Obelisk*
Removes all rows in a base table.
@ -25,6 +24,7 @@ Removes all rows in a base table.
The target table.
**`<as-of-time>`**
*as-of-time not currently supported in urQL parser or in Obelisk*
Timestamp of table creation. Defaults to `NOW` (current time). When specified, the timestamp must be greater than both the latest database schema and content timestamps.
### Remarks
@ -35,7 +35,7 @@ Tables in the *sys* namespace cannot be truncated.
### Produced Metadata
Row count
Row count (when table was populated)
Content timestamp (labelled 'data time')
### Exceptions

View File

@ -64,7 +64,6 @@ Avoid using `ORDER BY` in CTEs or in any query prior to the last step in a `<tra
| expression [ NOT ] BETWEEN expression [ AND ] expression
| [ NOT ] EXISTS { <column value> | <scalar-query> } }
```
*BETWEEN ... AND ... is not yet implemented in the urQL parser*
When applied to a column `EXISTS` tests whether the returned `<row-type>` includes the required column. In the case of `<scalar-query>`, it tests whether a CTE returns any rows.
`[ NOT ] EQUIV` is a binary operator, similar to (not) equals `<>`, `=`. However, comparing two `NOT EXISTS` yields true.

View File

@ -24,7 +24,7 @@ To Do:
TO { PARENT | SIBLINGS | MOONS | <@p> [ ,...n ] }
ON { DATABASE <database>
| NAMESPACE [<database>.] <namespace>
| [<db-qualifer>] <table-object>
| [<db-qualifier>] <table-object>
}
```
@ -67,10 +67,10 @@ Grantees are all moons of the ship on which Obelisk agent is running.
List of ships to grant permission to.
**`<database>`**
Grant permissin on named database to all `<table>s` and `<view>`s.
Grant permission on named database to all `<table>s` and `<view>`s.
**`[<database>.]<namespace>`**
Grant permissin on named namespace to all `<table>s` and `<view>`s.
Grant permission on named namespace to all `<table>s` and `<view>`s.
**`[<db-qualifer>]<table-object>`**
Grant permission is on named object, whether is is a `<table>` or `<view>`.
@ -109,7 +109,7 @@ Revokes permission to read from and/or write to selected database objects on the
FROM { PARENT | SIBLINGS | MOONS | ALL | <@p> [ ,...n ] }
ON { DATABASE <database>
| NAMESPACE [<database>.] <namespace>
| [<db-qualifer>] <table-object>
| [<db-qualifier>] <table-object>
}
```
@ -152,7 +152,7 @@ List of ships from which permission will be revoked.
Revoke permission on the named database.
**`[<database>.]<namespace>`**
Revoke permissin on named namespace.
Revoke permission on named namespace.
**`[<db-qualifer>]<table-object>`**
Revoke permission is on named object, whether it is a `<table>` or `<view>`.