Added sum to docs

thingsdb · Jul 21, 2023 · 5d88e57 · 5d88e57
1 parent 7e7a579
commit 5d88e57
Show file tree

Hide file tree

Showing 291 changed files with 338 additions and 288 deletions.
diff --git a/v1/content/collection-api/_index.md b/v1/content/collection-api/_index.md
@@ -1,6 +1,6 @@
 ---
 title: "Collection API"
-weight: 194
+weight: 195
 chapter: true
 ---
 

diff --git a/v1/content/collection-api/alt_raise.md b/v1/content/collection-api/alt_raise.md
@@ -1,6 +1,6 @@
 ---
 title: "alt_raise"
-weight: 195
+weight: 196
 ---
 
 This function will try a statement. If the statement is successful it will just return the result but in case of an error, it will re-raise the error using a given error code.

diff --git a/v1/content/collection-api/assert.md b/v1/content/collection-api/assert.md
@@ -1,6 +1,6 @@
 ---
 title: "assert"
-weight: 196
+weight: 197
 ---
 
 Raises an [assert_err()](../../errors/assert_err) if the specified expression evaluates to `false`.

diff --git a/v1/content/collection-api/base64_decode.md b/v1/content/collection-api/base64_decode.md
@@ -1,6 +1,6 @@
 ---
 title: "base64_decode"
-weight: 197
+weight: 198
 ---
 
 Decode a Base64 encoded string.

diff --git a/v1/content/collection-api/base64_encode.md b/v1/content/collection-api/base64_encode.md
@@ -1,6 +1,6 @@
 ---
 title: "base64_encode"
-weight: 198
+weight: 199
 ---
 
 Encode a [str](../../data-types/str) or [bytes](../../data-types/bytes) value using Base64.

diff --git a/v1/content/collection-api/bool.md b/v1/content/collection-api/bool.md
@@ -1,6 +1,6 @@
 ---
 title: "bool"
-weight: 199
+weight: 200
 ---
 
 Returns a [bool](../../data-types/bool) from a specified value.

diff --git a/v1/content/collection-api/bytes.md b/v1/content/collection-api/bytes.md
@@ -1,6 +1,6 @@
 ---
 title: "bytes"
-weight: 200
+weight: 201
 ---
 
 Convert a value to a byte sequence. If no value is given, an empty byte sequence is returned.

diff --git a/v1/content/collection-api/change_id.md b/v1/content/collection-api/change_id.md
@@ -1,6 +1,6 @@
 ---
 title: "change_id"
-weight: 201
+weight: 202
 ---
 
 Returns the current change Id for the running query. The return value will be `nil` if the query does not require a *change*.

diff --git a/v1/content/collection-api/closure.md b/v1/content/collection-api/closure.md
@@ -1,6 +1,6 @@
 ---
 title: "closure"
-weight: 202
+weight: 203
 ---
 
 Returns an [closure](../../data-types/closure) from a given string.

diff --git a/v1/content/collection-api/datetime.md b/v1/content/collection-api/datetime.md
@@ -1,6 +1,6 @@
 ---
 title: "datetime"
-weight: 203
+weight: 204
 ---
 
 Returns a [datetime](../../data-types/datetime) depending on some optional values.

diff --git a/v1/content/collection-api/deep.md b/v1/content/collection-api/deep.md
@@ -1,6 +1,6 @@
 ---
 title: "deep"
-weight: 204
+weight: 205
 ---
 
 Set or return the current `deep` value for the **running query**. The deep value indicates how far down the result of a query is returned. For example, *thing1* may contain a *thing2* that contains a *thing3*. A deep value of 1 would only show the content of *thing1* and a deep value of 3 will go as deep as the content of *thing3*. ThingsDB allows *deep* to have a value between `0` and `127`.

diff --git a/v1/content/collection-api/del_enum.md b/v1/content/collection-api/del_enum.md
@@ -1,6 +1,6 @@
 ---
 title: "del_enum"
-weight: 205
+weight: 206
 ---
 
 Deletes an existing [enumerator type](../../data-types/enum).

diff --git a/v1/content/collection-api/del_type.md b/v1/content/collection-api/del_type.md
@@ -1,6 +1,6 @@
 ---
 title: "del_type"
-weight: 206
+weight: 207
 ---
 
 Deletes an existing [Type](../../overview/type).

diff --git a/v1/content/collection-api/enum.md b/v1/content/collection-api/enum.md
@@ -1,6 +1,6 @@
 ---
 title: "enum"
-weight: 207
+weight: 208
 ---
 
 Returns a [enum](../../data-types/enum) member from a given value.

diff --git a/v1/content/collection-api/enum_info.md b/v1/content/collection-api/enum_info.md
@@ -1,6 +1,6 @@
 ---
 title: "enum_info"
-weight: 208
+weight: 209
 ---
 
 Returns information about a given [enumeration type](../../data-types/enum).

diff --git a/v1/content/collection-api/enum_map.md b/v1/content/collection-api/enum_map.md
@@ -1,6 +1,6 @@
 ---
 title: "enum_map"
-weight: 209
+weight: 210
 ---
 
 Returns a thing with key/value pairs for all the members of a given enum.

diff --git a/v1/content/collection-api/enums_info.md b/v1/content/collection-api/enums_info.md
@@ -1,6 +1,6 @@
 ---
 title: "enums_info"
-weight: 210
+weight: 211
 ---
 
 Returns [enumeration type](../../data-types/enum) information about all the enum's within a collection scope.

diff --git a/v1/content/collection-api/err.md b/v1/content/collection-api/err.md
@@ -1,6 +1,6 @@
 ---
 title: "err"
-weight: 211
+weight: 212
 ---
 
 Returns an [error](../../data-types/error).

diff --git a/v1/content/collection-api/float.md b/v1/content/collection-api/float.md
@@ -1,6 +1,6 @@
 ---
 title: "float"
-weight: 212
+weight: 213
 ---
 
 Returns a [float](../../data-types/float) from a specified value.

diff --git a/v1/content/collection-api/future.md b/v1/content/collection-api/future.md
@@ -1,6 +1,6 @@
 ---
 title: "future"
-weight: 213
+weight: 214
 ---
 
 Returns a [future](../../data-types/future). It is *not* possible to assign a future to

diff --git a/v1/content/collection-api/has_enum.md b/v1/content/collection-api/has_enum.md
@@ -1,6 +1,6 @@
 ---
 title: "has_enum"
-weight: 214
+weight: 215
 ---
 
 Determines if a [enumerator type](../../data-types/enum) exists in the current `@collection` scope.

diff --git a/v1/content/collection-api/has_type.md b/v1/content/collection-api/has_type.md
@@ -1,6 +1,6 @@
 ---
 title: "has_type"
-weight: 215
+weight: 216
 ---
 
 Determines if a [Type](../../overview/type) exists in the current `@collection` scope.

diff --git a/v1/content/collection-api/int.md b/v1/content/collection-api/int.md
@@ -1,6 +1,6 @@
 ---
 title: "int"
-weight: 216
+weight: 217
 ---
 
 Returns an [int](../../data-types/int) from a specified value.

diff --git a/v1/content/collection-api/is/_index.md b/v1/content/collection-api/is/_index.md
@@ -1,6 +1,6 @@
 ---
 title: "is..."
-weight: 217
+weight: 218
 ---
 
 There are many functions in ThingsDB to check if a value is compatible with some specification.

diff --git a/v1/content/collection-api/is/is_array.md b/v1/content/collection-api/is/is_array.md
@@ -1,6 +1,6 @@
 ---
 title: "is_array"
-weight: 218
+weight: 219
 ---
 
 This function determines whether the provided value is of type [list](../../../data-types/list) or [tuple](../../../data-types/tuple) or not. The functions [is_list](../../../collection-api/is/is_list) and

diff --git a/v1/content/collection-api/is/is_ascii.md b/v1/content/collection-api/is/is_ascii.md
@@ -1,6 +1,6 @@
 ---
 title: "is_ascii"
-weight: 219
+weight: 220
 ---
 
 This function determines whether the provided value is of

diff --git a/v1/content/collection-api/is/is_bool.md b/v1/content/collection-api/is/is_bool.md
@@ -1,6 +1,6 @@
 ---
 title: "is_bool"
-weight: 220
+weight: 221
 ---
 
 This function determines whether the provided value is a [bool](../../../data-types/bool) or not.

diff --git a/v1/content/collection-api/is/is_bytes.md b/v1/content/collection-api/is/is_bytes.md
@@ -1,6 +1,6 @@
 ---
 title: "is_bytes"
-weight: 221
+weight: 222
 ---
 
 This function determines whether the provided value is of type [bytes](../../../data-types/bytes) or not.

diff --git a/v1/content/collection-api/is/is_closure.md b/v1/content/collection-api/is/is_closure.md
@@ -1,6 +1,6 @@
 ---
 title: "is_closure"
-weight: 222
+weight: 223
 ---
 
 This function determines whether the provided value is a [closure](../../../data-types/closure) or not.

diff --git a/v1/content/collection-api/is/is_datetime.md b/v1/content/collection-api/is/is_datetime.md
@@ -1,6 +1,6 @@
 ---
 title: "is_datetime"
-weight: 223
+weight: 224
 ---
 
 This function determines whether the provided value is of

diff --git a/v1/content/collection-api/is/is_email.md b/v1/content/collection-api/is/is_email.md
@@ -1,6 +1,6 @@
 ---
 title: "is_email"
-weight: 224
+weight: 225
 ---
 
 This function determines whether the provided value is of

diff --git a/v1/content/collection-api/is/is_enum.md b/v1/content/collection-api/is/is_enum.md
@@ -1,6 +1,6 @@
 ---
 title: "is_enum"
-weight: 225
+weight: 226
 ---
 
 This function determines whether the provided value is an [enumeration type](../../../data-types/enum) member or not.

diff --git a/v1/content/collection-api/is/is_err.md b/v1/content/collection-api/is/is_err.md
@@ -1,6 +1,6 @@
 ---
 title: "is_err"
-weight: 226
+weight: 227
 ---
 
 This function determines whether the provided value is a [error](../../../data-types/error) or not.

diff --git a/v1/content/collection-api/is/is_float.md b/v1/content/collection-api/is/is_float.md
@@ -1,6 +1,6 @@
 ---
 title: "is_float"
-weight: 227
+weight: 228
 ---
 
 This function determines whether the provided value is a [floating point](../../../data-types/float) value or not.

diff --git a/v1/content/collection-api/is/is_future.md b/v1/content/collection-api/is/is_future.md
@@ -1,6 +1,6 @@
 ---
 title: "is_future"
-weight: 228
+weight: 229
 ---
 
 This function determines whether the provided value is a [future](../../../data-types/future) value or not.

diff --git a/v1/content/collection-api/is/is_inf.md b/v1/content/collection-api/is/is_inf.md
@@ -1,6 +1,6 @@
 ---
 title: "is_inf"
-weight: 229
+weight: 230
 ---
 
 This function determines whether the provided value is a positive or negative *infinity*.

diff --git a/v1/content/collection-api/is/is_int.md b/v1/content/collection-api/is/is_int.md
@@ -1,6 +1,6 @@
 ---
 title: "is_int"
-weight: 230
+weight: 231
 ---
 
 This function determines whether the provided value is an [integer](../../../data-types/int) or not.

diff --git a/v1/content/collection-api/is/is_list.md b/v1/content/collection-api/is/is_list.md
@@ -1,6 +1,6 @@
 ---
 title: "is_list"
-weight: 231
+weight: 232
 ---
 
 This function determines whether the provided value is a [list](../../../data-types/list) or not.

diff --git a/v1/content/collection-api/is/is_mpdata.md b/v1/content/collection-api/is/is_mpdata.md
@@ -1,6 +1,6 @@
 ---
 title: "is_mpdata"
-weight: 232
+weight: 233
 ---
 
 This function determines whether the provided value is of type [mpdata](../../../data-types/) or not.

diff --git a/v1/content/collection-api/is/is_nan.md b/v1/content/collection-api/is/is_nan.md
@@ -1,6 +1,6 @@
 ---
 title: "is_nan"
-weight: 233
+weight: 234
 ---
 
 This function determines whether the provided value is not a number.

diff --git a/v1/content/collection-api/is/is_nil.md b/v1/content/collection-api/is/is_nil.md
@@ -1,6 +1,6 @@
 ---
 title: "is_nil"
-weight: 234
+weight: 235
 ---
 
 This function determines whether the provided value is [nil](../../../data-types/nil).

diff --git a/v1/content/collection-api/is/is_raw.md b/v1/content/collection-api/is/is_raw.md
@@ -1,6 +1,6 @@
 ---
 title: "is_raw"
-weight: 235
+weight: 236
 ---
 
 This function determines whether the provided value is of type [str](../../../data-types/str) *or* [bytes](../../../data-types/bytes).

diff --git a/v1/content/collection-api/is/is_regex.md b/v1/content/collection-api/is/is_regex.md
@@ -1,6 +1,6 @@
 ---
 title: "is_regex"
-weight: 236
+weight: 237
 ---
 
 This function determines whether the provided value is of type [regex](../../../data-types/regex) or not.

diff --git a/v1/content/collection-api/is/is_room.md b/v1/content/collection-api/is/is_room.md
@@ -1,6 +1,6 @@
 ---
 title: "is_room"
-weight: 237
+weight: 238
 ---
 
 This function determines whether the provided value is a [room](../../../data-types/room) or not.

diff --git a/v1/content/collection-api/is/is_set.md b/v1/content/collection-api/is/is_set.md
@@ -1,6 +1,6 @@
 ---
 title: "is_set"
-weight: 238
+weight: 239
 ---
 
 This function determines whether the provided value is a [set](../../../data-types/set) or not.

diff --git a/v1/content/collection-api/is/is_str.md b/v1/content/collection-api/is/is_str.md
@@ -1,6 +1,6 @@
 ---
 title: "is_str"
-weight: 239
+weight: 240
 ---
 
 This function determines whether the provided value is of type [str](../../../data-types/str).

diff --git a/v1/content/collection-api/is/is_task.md b/v1/content/collection-api/is/is_task.md
@@ -1,6 +1,6 @@
 ---
 title: "is_task"
-weight: 240
+weight: 241
 ---
 
 This function determines whether the provided value is a [task](../../../data-types/task) or not.

diff --git a/v1/content/collection-api/is/is_tel.md b/v1/content/collection-api/is/is_tel.md
@@ -1,6 +1,6 @@
 ---
 title: "is_tel"
-weight: 241
+weight: 242
 ---
 
 This function determines whether the provided value is of

diff --git a/v1/content/collection-api/is/is_thing.md b/v1/content/collection-api/is/is_thing.md
@@ -1,6 +1,6 @@
 ---
 title: "is_thing"
-weight: 242
+weight: 243
 ---
 
 This function determines whether the provided value is a [thing](../../../data-types/thing) or not.

diff --git a/v1/content/collection-api/is/is_time_zone.md b/v1/content/collection-api/is/is_time_zone.md
@@ -1,6 +1,6 @@
 ---
 title: "is_time_zone"
-weight: 243
+weight: 244
 ---
 
 This function determines whether the provided value is of