Skip to content

Commit b01b0f9

Browse files
committed
Issue #26: Add pgv_set() and pgv_get() arguments description
1 parent 0e25dd1 commit b01b0f9

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

Diff for: README.md

+22
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,28 @@ Function | Returns
102102
`pgv_set(package text, name text, value anyarray, is_transactional bool default false)` | `void`
103103
`pgv_get(package text, name text, var_type anyarray, strict bool default true)` | `anyarray`
104104

105+
`pgv_set` arguments:
106+
- `package` - name of the package, it will be created if it doesn't exist.
107+
- `name` - name of the variable, it will be created if it doesn't exist.
108+
`pgv_set` fails if the variable already exists and its transactionality doesn't
109+
match `is_transactional` argument.
110+
- `value` - new value for the variable. `pgv_set` fails if the variable already
111+
exists and its type doesn't match new value's type.
112+
- `is_transactional` - transactionality of the newly created variable, by
113+
default it is false.
114+
115+
`pgv_get` arguments:
116+
- `package` - name of the existing package. If the package doesn't exist result
117+
depends on `strict` argument: if it is false then `pgv_get` returns NULL
118+
otherwise it fails.
119+
- `name` - name of the the existing variable. If the variable doesn't exist
120+
result depends on `strict` argument: if it is false then `pgv_get` returns NULL
121+
otherwise it fails.
122+
- `var_type` - type of the existing variable. It is necessary to pass it to get
123+
correct return type.
124+
- `strict` - pass false if `pgv_get` shouldn't raise an error if a variable or a
125+
package didn't created before, by default it is true.
126+
105127
## **Deprecated** scalar variables functions
106128

107129
### Integer variables

0 commit comments

Comments
 (0)