Merge pull request #45 from tgpfeiffer/array_length

add documentation for array_length
sensorbee · Jul 12, 2016 · bc30d88 · bc30d88
2 parents a99c0f1 + 8f08bfc
commit bc30d88
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 0 deletions.
diff --git a/source/bql/functions.rst b/source/bql/functions.rst
@@ -166,6 +166,16 @@ Time Functions
 +-----------------------------------------------------+--------------------------------------------------------------+
 
 
+Array Functions
+===============
+
++-------------------------------------------------------+---------------------------------------------------+
+| Function                                              | Description                                       |
++=======================================================+===================================================+
+| :ref:`array_length(a) <ref_func_array_length>`        | number of elements in an array                    |
++-------------------------------------------------------+---------------------------------------------------+
+
+
 Other Scalar Functions
 ======================
 

diff --git a/source/ref/functions.rst b/source/ref/functions.rst
@@ -1694,6 +1694,48 @@ Return Type
 
 
 
+Array Functions
+===============
+
+
+.. _ref_func_array_length:
+
+``array_length``
+----------------
+
+::
+
+    array_length(a)
+
+Description
+^^^^^^^^^^^
+
+``array_length`` computes the number of elements in an array ``a``.
+Elements with a NULL value are also counted.
+
+
+Parameter Types
+^^^^^^^^^^^^^^^
+
+``a``
+    ``array``
+
+Return Type
+^^^^^^^^^^^
+
+``int``
+
+Examples
+^^^^^^^^
+
++------------------------------------+----------+
+| Function Call                      | Result   |
++====================================+==========+
+| ``array_length([3, NULL, "foo"])`` | ``3``    |
++------------------------------------+----------+
+
+
+
 
 Other Scalar Functions
 ======================