File: functions-array.html

package info (click to toggle)
pgadmin3 1.4.3-2
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 29,796 kB
  • ctags: 10,758
  • sloc: cpp: 55,356; sh: 6,164; ansic: 1,520; makefile: 576; sql: 482; xml: 100; perl: 18
file content (209 lines) | stat: -rw-r--r-- 7,889 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>9.14.Array Functions and Operators</title>
<link rel="stylesheet" href="stylesheet.css" type="text/css">
<link rev="made" href="pgsql-docs@postgresql.org">
<meta name="generator" content="DocBook XSL Stylesheets V1.70.0">
<link rel="start" href="index.html" title="PostgreSQL 8.1.4 Documentation">
<link rel="up" href="functions.html" title="Chapter9.Functions and Operators">
<link rel="prev" href="functions-conditional.html" title="9.13.Conditional Expressions">
<link rel="next" href="functions-aggregate.html" title="9.15.Aggregate Functions">
<link rel="copyright" href="ln-legalnotice.html" title="Legal Notice">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="sect1" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="functions-array"></a>9.14.Array Functions and Operators</h2></div></div></div>
<p>   <a href="functions-array.html#array-operators-table" title="Table9.35.array Operators">Table9.35, &#8220;<code class="type">array</code> Operators&#8221;</a> shows the operators
   available for <code class="type">array</code> types.
  </p>
<div class="table">
<a name="array-operators-table"></a><p class="title"><b>Table9.35.<code class="type">array</code> Operators</b></p>
<div class="table-contents"><table summary="array Operators" border="1">
<colgroup>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Operator</th>
<th>Description</th>
<th>Example</th>
<th>Result</th>
</tr></thead>
<tbody>
<tr>
<td> <code class="literal">=</code> </td>
<td>equal</td>
<td><code class="literal">ARRAY[1.1,2.1,3.1]::int[] = ARRAY[1,2,3]</code></td>
<td><code class="literal">t</code></td>
</tr>
<tr>
<td> <code class="literal">&lt;&gt;</code> </td>
<td>not equal</td>
<td><code class="literal">ARRAY[1,2,3] &lt;&gt; ARRAY[1,2,4]</code></td>
<td><code class="literal">t</code></td>
</tr>
<tr>
<td> <code class="literal">&lt;</code> </td>
<td>less than</td>
<td><code class="literal">ARRAY[1,2,3] &lt; ARRAY[1,2,4]</code></td>
<td><code class="literal">t</code></td>
</tr>
<tr>
<td> <code class="literal">&gt;</code> </td>
<td>greater than</td>
<td><code class="literal">ARRAY[1,4,3] &gt; ARRAY[1,2,4]</code></td>
<td><code class="literal">t</code></td>
</tr>
<tr>
<td> <code class="literal">&lt;=</code> </td>
<td>less than or equal</td>
<td><code class="literal">ARRAY[1,2,3] &lt;= ARRAY[1,2,3]</code></td>
<td><code class="literal">t</code></td>
</tr>
<tr>
<td> <code class="literal">&gt;=</code> </td>
<td>greater than or equal</td>
<td><code class="literal">ARRAY[1,4,3] &gt;= ARRAY[1,4,3]</code></td>
<td><code class="literal">t</code></td>
</tr>
<tr>
<td> <code class="literal">||</code> </td>
<td>array-to-array concatenation</td>
<td><code class="literal">ARRAY[1,2,3] || ARRAY[4,5,6]</code></td>
<td><code class="literal">{1,2,3,4,5,6}</code></td>
</tr>
<tr>
<td> <code class="literal">||</code> </td>
<td>array-to-array concatenation</td>
<td><code class="literal">ARRAY[1,2,3] || ARRAY[[4,5,6],[7,8,9]]</code></td>
<td><code class="literal">{{1,2,3},{4,5,6},{7,8,9}}</code></td>
</tr>
<tr>
<td> <code class="literal">||</code> </td>
<td>element-to-array concatenation</td>
<td><code class="literal">3 || ARRAY[4,5,6]</code></td>
<td><code class="literal">{3,4,5,6}</code></td>
</tr>
<tr>
<td> <code class="literal">||</code> </td>
<td>array-to-element concatenation</td>
<td><code class="literal">ARRAY[4,5,6] || 7</code></td>
<td><code class="literal">{4,5,6,7}</code></td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break"><p>   See <a href="arrays.html" title="8.10.Arrays">Section8.10, &#8220;Arrays&#8221;</a> for more details about array operator
   behavior.
  </p>
<p>   <a href="functions-array.html#array-functions-table" title="Table9.36.array Functions">Table9.36, &#8220;<code class="type">array</code> Functions&#8221;</a> shows the functions
   available for use with array types. See <a href="arrays.html" title="8.10.Arrays">Section8.10, &#8220;Arrays&#8221;</a>
   for more discussion and examples of the use of these functions.
  </p>
<div class="table">
<a name="array-functions-table"></a><p class="title"><b>Table9.36.<code class="type">array</code> Functions</b></p>
<div class="table-contents"><table summary="array Functions" border="1">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Function</th>
<th>Return Type</th>
<th>Description</th>
<th>Example</th>
<th>Result</th>
</tr></thead>
<tbody>
<tr>
<td>     <code class="literal">      <code class="function">array_cat</code>
      (<code class="type">anyarray</code>, <code class="type">anyarray</code>)
     </code>
    </td>
<td><code class="type">anyarray</code></td>
<td>concatenate two arrays</td>
<td><code class="literal">array_cat(ARRAY[1,2,3], ARRAY[4,5])</code></td>
<td><code class="literal">{1,2,3,4,5}</code></td>
</tr>
<tr>
<td>     <code class="literal">      <code class="function">array_append</code>
      (<code class="type">anyarray</code>, <code class="type">anyelement</code>)
     </code>
    </td>
<td><code class="type">anyarray</code></td>
<td>append an element to the end of an array</td>
<td><code class="literal">array_append(ARRAY[1,2], 3)</code></td>
<td><code class="literal">{1,2,3}</code></td>
</tr>
<tr>
<td>     <code class="literal">      <code class="function">array_prepend</code>
      (<code class="type">anyelement</code>, <code class="type">anyarray</code>)
     </code>
    </td>
<td><code class="type">anyarray</code></td>
<td>append an element to the beginning of an array</td>
<td><code class="literal">array_prepend(1, ARRAY[2,3])</code></td>
<td><code class="literal">{1,2,3}</code></td>
</tr>
<tr>
<td>     <code class="literal">      <code class="function">array_dims</code>
      (<code class="type">anyarray</code>)
     </code>
    </td>
<td><code class="type">text</code></td>
<td>returns a text representation of array's dimensions</td>
<td><code class="literal">array_dims(ARRAY[[1,2,3], [4,5,6]])</code></td>
<td><code class="literal">[1:2][1:3]</code></td>
</tr>
<tr>
<td>     <code class="literal">      <code class="function">array_lower</code>
      (<code class="type">anyarray</code>, <code class="type">int</code>)
     </code>
    </td>
<td><code class="type">int</code></td>
<td>returns lower bound of the requested array dimension</td>
<td><code class="literal">array_lower(array_prepend(0, ARRAY[1,2,3]), 1)</code></td>
<td><code class="literal">0</code></td>
</tr>
<tr>
<td>     <code class="literal">      <code class="function">array_upper</code>
      (<code class="type">anyarray</code>, <code class="type">int</code>)
     </code>
    </td>
<td><code class="type">int</code></td>
<td>returns upper bound of the requested array dimension</td>
<td><code class="literal">array_upper(ARRAY[1,2,3,4], 1)</code></td>
<td><code class="literal">4</code></td>
</tr>
<tr>
<td>     <code class="literal">      <code class="function">array_to_string</code>
      (<code class="type">anyarray</code>, <code class="type">text</code>)
     </code>
    </td>
<td><code class="type">text</code></td>
<td>concatenates array elements using provided delimiter</td>
<td><code class="literal">array_to_string(ARRAY[1, 2, 3], '~^~')</code></td>
<td><code class="literal">1~^~2~^~3</code></td>
</tr>
<tr>
<td>     <code class="literal">      <code class="function">string_to_array</code>
      (<code class="type">text</code>, <code class="type">text</code>)
     </code>
    </td>
<td><code class="type">text[]</code></td>
<td>splits string into array elements using provided delimiter</td>
<td><code class="literal">string_to_array('xx~^~yy~^~zz', '~^~')</code></td>
<td><code class="literal">{xx,yy,zz}</code></td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break">
</div></body>
</html>