source: trunk/doc/reference_management.xml @ 4817

Last change on this file since 4817 was 4817, checked in by colivier, 7 years ago

Split reference.xml on several sub files (upon sect1). Use entity to avoid redundant compliant/support text (SFS, SQL/MM, Z/M dimensions, Curve support)

File size: 25.6 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2  <sect1 id="Management_Functions">
3        <title>Management Functions</title>
4
5        <refentry id="AddGeometryColumn">
6          <refnamediv>
7                <refname>AddGeometryColumn</refname>
8
9                <refpurpose>Adds a geometry column to an existing table of
10                attributes.</refpurpose>
11          </refnamediv>
12
13          <refsynopsisdiv>
14                <funcsynopsis>
15                  <funcprototype>
16                        <funcdef>text <function>AddGeometryColumn</function></funcdef>
17
18                        <paramdef><type>varchar </type>
19                        <parameter>table_name</parameter></paramdef>
20
21                        <paramdef><type>varchar </type>
22                        <parameter>column_name</parameter></paramdef>
23
24                        <paramdef><type>integer </type>
25                        <parameter>srid</parameter></paramdef>
26
27                        <paramdef><type>varchar </type>
28                        <parameter>type</parameter></paramdef>
29
30                        <paramdef><type>integer </type>
31                        <parameter>dimension</parameter></paramdef>
32                  </funcprototype>
33
34                  <funcprototype>
35                        <funcdef>text <function>AddGeometryColumn</function></funcdef>
36
37                        <paramdef><type>varchar </type>
38                        <parameter>schema_name</parameter></paramdef>
39
40                        <paramdef><type>varchar </type>
41                        <parameter>table_name</parameter></paramdef>
42
43                        <paramdef><type>varchar </type>
44                        <parameter>column_name</parameter></paramdef>
45
46                        <paramdef><type>integer </type>
47                        <parameter>srid</parameter></paramdef>
48
49                        <paramdef><type>varchar </type>
50                        <parameter>type</parameter></paramdef>
51
52                        <paramdef><type>integer </type>
53                        <parameter>dimension</parameter></paramdef>
54                  </funcprototype>
55
56                  <funcprototype>
57                        <funcdef>text <function>AddGeometryColumn</function></funcdef>
58
59                        <paramdef><type>varchar </type>
60                        <parameter>catalog_name</parameter></paramdef>
61
62                        <paramdef><type>varchar </type>
63                        <parameter>schema_name</parameter></paramdef>
64
65                        <paramdef><type>varchar </type>
66                        <parameter>table_name</parameter></paramdef>
67
68                        <paramdef><type>varchar </type>
69                        <parameter>column_name</parameter></paramdef>
70
71                        <paramdef><type>integer </type>
72                        <parameter>srid</parameter></paramdef>
73
74                        <paramdef><type>varchar </type>
75                        <parameter>type</parameter></paramdef>
76
77                        <paramdef><type>integer </type>
78                        <parameter>dimension</parameter></paramdef>
79                  </funcprototype>
80                </funcsynopsis>
81          </refsynopsisdiv>
82
83          <refsection>
84                <title>Description</title>
85
86                <para>Adds a geometry column to an existing table of attributes. The
87                <varname>schema_name</varname> is the name of the table schema (unused
88                for pre-schema PostgreSQL installations). The <varname>srid</varname>
89                must be an integer value reference to an entry in the SPATIAL_REF_SYS
90                table. The <varname>type</varname> must be an uppercase string
91                corresponding to the geometry type, eg, 'POLYGON' or
92                'MULTILINESTRING'.  An error is thrown if the schemaname doesn't exist
93                (or not visible in the current search_path) or the specified SRID,
94                geometry type, or dimension is invalid.</para>
95
96                <note>
97                        <para>Views and derivatively created spatial tables will need to be registered in geometry_columns manually,
98                                since AddGeometryColumn also adds a spatial column which is not needed when you already have a spatial column.  Refer to <xref linkend="Manual_Register_Spatial_Column"/>.
99                        </para>
100                </note>
101                <para>&sfs_compliant;</para>
102                <para>&Z_support;</para>
103                <para>&curve_support;</para>
104          </refsection>
105
106          <refsection>
107                <title>Examples</title>
108
109                <programlisting>
110-- Create a new simple PostgreSQL table
111postgis=# CREATE TABLE my_schema.my_spatial_table (id serial);
112
113-- Describing the table shows a simple table with a single "id" column.
114postgis=# \d my_schema.my_spatial_table
115                                                         Table "my_schema.my_spatial_table"
116 Column |  Type   |                                Modifiers
117--------+---------+-------------------------------------------------------------------------
118 id     | integer | not null default nextval('my_schema.my_spatial_table_id_seq'::regclass)
119
120-- Add a spatial column to the table
121postgis=# SELECT AddGeometryColumn ('my_schema','my_spatial_table','the_geom',4326,'POINT',2);
122
123--Add a curvepolygon
124SELECT AddGeometryColumn ('my_schema','my_spatial_table','the_geomcp',4326,'CURVEPOLYGON',2);
125
126-- Describe the table again reveals the addition of a new "the_geom" column.
127postgis=# \d my_schema.my_spatial_table
128   Column   |   Type   |                                Modifiers
129
130------------+----------+-------------------------------------------------------------------------
131 id         | integer  | not null default nextval('my_schema.my_spatial_table_id_seq'::regclass)
132 the_geom   | geometry |
133 the_geomcp | geometry |
134Check constraints:
135        "enforce_dims_the_geom" CHECK (ndims(the_geom) = 2)
136        "enforce_dims_the_geomcp" CHECK (ndims(the_geomcp) = 2)
137        "enforce_geotype_the_geom" CHECK (geometrytype(the_geom) = 'POINT'::text OR
138the_geom IS NULL)
139        "enforce_geotype_the_geomcp" CHECK (geometrytype(the_geomcp) = 'CURVEPOLYGON
140'::text OR the_geomcp IS NULL)
141        "enforce_srid_the_geom" CHECK (srid(the_geom) = 4326)
142        "enforce_srid_the_geomcp" CHECK (srid(the_geomcp) = 4326)</programlisting>
143          </refsection>
144
145          <refsection>
146                <title>See Also</title>
147
148                <para><xref linkend="DropGeometryColumn"/>, <xref linkend="DropGeometryTable"/>, <xref linkend="Manual_Register_Spatial_Column"/></para>
149          </refsection>
150        </refentry>
151
152        <refentry id="DropGeometryColumn">
153          <refnamediv>
154                <refname>DropGeometryColumn</refname>
155
156                <refpurpose>Removes a geometry column from a spatial
157                table.</refpurpose>
158          </refnamediv>
159
160          <refsynopsisdiv>
161                <funcsynopsis>
162                  <funcprototype>
163                        <funcdef>text <function>DropGeometryColumn</function></funcdef>
164
165                        <paramdef><type>varchar </type>
166                        <parameter>table_name</parameter></paramdef>
167
168                        <paramdef><type>varchar </type>
169                        <parameter>column_name</parameter></paramdef>
170                  </funcprototype>
171
172                  <funcprototype>
173                        <funcdef>text <function>DropGeometryColumn</function></funcdef>
174
175                        <paramdef><type>varchar </type>
176                        <parameter>schema_name</parameter></paramdef>
177
178                        <paramdef><type>varchar </type>
179                        <parameter>table_name</parameter></paramdef>
180
181                        <paramdef><type>varchar </type>
182                        <parameter>column_name</parameter></paramdef>
183                  </funcprototype>
184
185                  <funcprototype>
186                        <funcdef>text <function>DropGeometryColumn</function></funcdef>
187
188                        <paramdef><type>varchar </type>
189                        <parameter>catalog_name</parameter></paramdef>
190
191                        <paramdef><type>varchar </type>
192                        <parameter>schema_name</parameter></paramdef>
193
194                        <paramdef><type>varchar </type>
195                        <parameter>table_name</parameter></paramdef>
196
197                        <paramdef><type>varchar </type>
198                        <parameter>column_name</parameter></paramdef>
199                  </funcprototype>
200                </funcsynopsis>
201          </refsynopsisdiv>
202
203          <refsection>
204                <title>Description</title>
205
206                <para>Removes a geometry column from a spatial table. Note that
207                schema_name will need to match the f_table_schema field of the table's
208                row in the geometry_columns table.</para>
209
210                <para>&sfs_compliant;</para>
211                <para>&Z_support;</para>
212                <para>&curve_support;</para>
213          </refsection>
214          <refsection>
215                <title>Examples</title>
216
217                <programlisting>
218                        SELECT DropGeometryColumn ('my_schema','my_spatial_table','the_geomcp');
219                        ----RESULT output ---
220                        my_schema.my_spatial_table.the_geomcp effectively removed.
221                </programlisting>
222          </refsection>
223          <refsection>
224                <title>See Also</title>
225
226                <para><xref linkend="AddGeometryColumn"/>, <xref linkend="DropGeometryTable"/></para>
227          </refsection>
228        </refentry>
229
230        <refentry id="DropGeometryTable">
231          <refnamediv>
232                <refname>DropGeometryTable</refname>
233
234                <refpurpose>Drops a table and all its references in
235                geometry_columns.</refpurpose>
236          </refnamediv>
237
238          <refsynopsisdiv>
239                <funcsynopsis>
240                  <funcprototype>
241                        <funcdef>boolean <function>DropGeometryTable</function></funcdef>
242
243                        <paramdef><type>varchar </type>
244                        <parameter>table_name</parameter></paramdef>
245                  </funcprototype>
246
247                  <funcprototype>
248                        <funcdef>boolean <function>DropGeometryTable</function></funcdef>
249
250                        <paramdef><type>varchar </type>
251                        <parameter>schema_name</parameter></paramdef>
252
253                        <paramdef><type>varchar </type>
254                        <parameter>table_name</parameter></paramdef>
255                  </funcprototype>
256
257                  <funcprototype>
258                        <funcdef>boolean <function>DropGeometryTable</function></funcdef>
259                        <paramdef><type>varchar </type>
260                        <parameter>catalog_name</parameter></paramdef>
261                        <paramdef><type>varchar </type>
262                        <parameter>schema_name</parameter></paramdef>
263                        <paramdef><type>varchar </type>
264                        <parameter>table_name</parameter></paramdef>
265                  </funcprototype>
266                </funcsynopsis>
267          </refsynopsisdiv>
268
269          <refsection>
270                <title>Description</title>
271
272                <para>Drops a table and all its references in geometry_columns. Note:
273                uses current_schema() on schema-aware pgsql installations if schema is
274                not provided.</para>
275          </refsection>
276
277          <refsection>
278                <title>Examples</title>
279
280                <programlisting>
281                        SELECT DropGeometryTable ('my_schema','my_spatial_table');
282                        ----RESULT output ---
283                        my_schema.my_spatial_table dropped.
284                </programlisting>
285          </refsection>
286          <refsection>
287                <title>See Also</title>
288
289                <para><xref linkend="AddGeometryColumn"/>, <xref linkend="DropGeometryColumn"/></para>
290          </refsection>
291        </refentry>
292
293
294        <refentry id="PostGIS_Full_Version">
295          <refnamediv>
296                <refname>PostGIS_Full_Version</refname>
297
298                <refpurpose>Reports full postgis version and build configuration
299                infos.</refpurpose>
300          </refnamediv>
301
302          <refsynopsisdiv>
303                <funcsynopsis>
304                  <funcprototype>
305                        <funcdef>text <function>PostGIS_Full_Version</function></funcdef>
306
307                        <paramdef></paramdef>
308                  </funcprototype>
309                </funcsynopsis>
310          </refsynopsisdiv>
311
312          <refsection>
313                <title>Description</title>
314
315                <para>Reports full postgis version and build configuration
316                infos.</para>
317          </refsection>
318
319          <refsection>
320                <title>Examples</title>
321
322                <programlisting>SELECT PostGIS_Full_Version();
323                                                           postgis_full_version
324----------------------------------------------------------------------------------
325 POSTGIS="1.3.3" GEOS="3.1.0-CAPI-1.5.0" PROJ="Rel. 4.4.9, 29 Oct 2004" USE_STATS
326(1 row)</programlisting>
327          </refsection>
328
329          <refsection>
330                <title>See Also</title>
331
332                <para><xref linkend="PostGIS_GEOS_Version" />, <xref
333                linkend="PostGIS_Lib_Version" />, <xref
334                linkend="PostGIS_PROJ_Version" />, <xref
335                linkend="PostGIS_Version" /></para>
336          </refsection>
337        </refentry>
338
339        <refentry id="PostGIS_GEOS_Version">
340          <refnamediv>
341                <refname>PostGIS_GEOS_Version</refname>
342
343                <refpurpose>Returns the version number of the GEOS
344                library.</refpurpose>
345          </refnamediv>
346
347          <refsynopsisdiv>
348                <funcsynopsis>
349                  <funcprototype>
350                        <funcdef>text <function>PostGIS_GEOS_Version</function></funcdef>
351
352                        <paramdef></paramdef>
353                  </funcprototype>
354                </funcsynopsis>
355          </refsynopsisdiv>
356
357          <refsection>
358                <title>Description</title>
359
360                <para>Returns the version number of the GEOS library, or
361                <varname>NULL</varname> if GEOS support is not enabled.</para>
362          </refsection>
363
364          <refsection>
365                <title>Examples</title>
366
367                <programlisting>SELECT PostGIS_GEOS_Version();
368 postgis_geos_version
369----------------------
370 3.1.0-CAPI-1.5.0
371(1 row)</programlisting>
372          </refsection>
373
374          <refsection>
375                <title>See Also</title>
376
377                <para><xref linkend="PostGIS_Full_Version" />, <xref
378                linkend="PostGIS_Lib_Version" />, <xref
379                linkend="PostGIS_PROJ_Version" />, <xref
380                linkend="PostGIS_Version" /></para>
381          </refsection>
382        </refentry>
383
384        <refentry id="PostGIS_Lib_Build_Date">
385          <refnamediv>
386                <refname>PostGIS_Lib_Build_Date</refname>
387
388                <refpurpose>Returns build date of the PostGIS library.</refpurpose>
389          </refnamediv>
390
391          <refsynopsisdiv>
392                <funcsynopsis>
393                  <funcprototype>
394                        <funcdef>text <function>PostGIS_Lib_Build_Date</function></funcdef>
395
396                        <paramdef></paramdef>
397                  </funcprototype>
398                </funcsynopsis>
399          </refsynopsisdiv>
400
401          <refsection>
402                <title>Description</title>
403
404                <para>Returns build date of the PostGIS library.</para>
405          </refsection>
406
407          <refsection>
408                <title>Examples</title>
409
410                <programlisting>SELECT PostGIS_Lib_Build_Date();
411 postgis_lib_build_date
412------------------------
413 2008-06-21 17:53:21
414(1 row)</programlisting>
415          </refsection>
416        </refentry>
417
418        <refentry id="PostGIS_Lib_Version">
419          <refnamediv>
420                <refname>PostGIS_Lib_Version</refname>
421
422                <refpurpose>Returns the version number of the PostGIS
423                library.</refpurpose>
424          </refnamediv>
425
426          <refsynopsisdiv>
427                <funcsynopsis>
428                  <funcprototype>
429                        <funcdef>text <function>PostGIS_Lib_Version</function></funcdef>
430
431                        <paramdef></paramdef>
432                  </funcprototype>
433                </funcsynopsis>
434          </refsynopsisdiv>
435
436          <refsection>
437                <title>Description</title>
438
439                <para>Returns the version number of the PostGIS library.</para>
440          </refsection>
441
442          <refsection>
443                <title>Examples</title>
444
445                <programlisting>SELECT PostGIS_Lib_Version();
446 postgis_lib_version
447---------------------
448 1.3.3
449(1 row)</programlisting>
450          </refsection>
451
452          <refsection>
453                <title>See Also</title>
454
455                <para><xref linkend="PostGIS_Full_Version" />, <xref
456                linkend="PostGIS_GEOS_Version" /><xref
457                linkend="PostGIS_PROJ_Version" />, <xref
458                linkend="PostGIS_Version" /></para>
459          </refsection>
460        </refentry>
461
462        <refentry id="PostGIS_PROJ_Version">
463          <refnamediv>
464                <refname>PostGIS_PROJ_Version</refname>
465
466                <refpurpose>Returns the version number of the PROJ4
467                library.</refpurpose>
468          </refnamediv>
469
470          <refsynopsisdiv>
471                <funcsynopsis>
472                  <funcprototype>
473                        <funcdef>text <function>PostGIS_PROJ_Version</function></funcdef>
474
475                        <paramdef></paramdef>
476                  </funcprototype>
477                </funcsynopsis>
478          </refsynopsisdiv>
479
480          <refsection>
481                <title>Description</title>
482
483                <para>Returns the version number of the PROJ4 library, or
484                <varname>NULL</varname> if PROJ4 support is not enabled.</para>
485          </refsection>
486
487          <refsection>
488                <title>Examples</title>
489
490                <programlisting>SELECT PostGIS_PROJ_Version();
491  postgis_proj_version
492-------------------------
493 Rel. 4.4.9, 29 Oct 2004
494(1 row)</programlisting>
495          </refsection>
496
497          <refsection>
498                <title>See Also</title>
499
500                <para><xref linkend="PostGIS_Full_Version" />, <xref
501                linkend="PostGIS_GEOS_Version" /><xref
502                linkend="PostGIS_Lib_Version" />, <xref
503                linkend="PostGIS_Version" /></para>
504          </refsection>
505        </refentry>
506
507        <refentry id="PostGIS_Scripts_Build_Date">
508          <refnamediv>
509                <refname>PostGIS_Scripts_Build_Date</refname>
510
511                <refpurpose>Returns build date of the PostGIS scripts.</refpurpose>
512          </refnamediv>
513
514          <refsynopsisdiv>
515                <funcsynopsis>
516                  <funcprototype>
517                        <funcdef>text <function>PostGIS_Scripts_Build_Date</function></funcdef>
518
519                        <paramdef></paramdef>
520                  </funcprototype>
521                </funcsynopsis>
522          </refsynopsisdiv>
523
524          <refsection>
525                <title>Description</title>
526
527                <para>Returns build date of the PostGIS scripts.</para>
528
529                <para>Availability: 1.0.0RC1</para>
530          </refsection>
531
532          <refsection>
533                <title>Examples</title>
534
535                <programlisting>SELECT PostGIS_Scripts_Build_Date();
536  postgis_scripts_build_date
537-------------------------
538 2007-08-18 09:09:26
539(1 row)</programlisting>
540          </refsection>
541
542          <refsection>
543                <title>See Also</title>
544
545                <para><xref linkend="PostGIS_Full_Version" />, <xref
546                linkend="PostGIS_GEOS_Version" />, <xref
547                linkend="PostGIS_Lib_Version" />, <xref
548                linkend="PostGIS_Version" /></para>
549          </refsection>
550        </refentry>
551
552        <refentry id="PostGIS_Scripts_Installed">
553          <refnamediv>
554                <refname>PostGIS_Scripts_Installed</refname>
555
556                <refpurpose>Returns version of the postgis scripts installed in this
557                        database.</refpurpose>
558          </refnamediv>
559
560          <refsynopsisdiv>
561                <funcsynopsis>
562                  <funcprototype>
563                        <funcdef>text <function>PostGIS_Scripts_Installed</function></funcdef>
564
565                        <paramdef></paramdef>
566                  </funcprototype>
567                </funcsynopsis>
568          </refsynopsisdiv>
569
570          <refsection>
571                <title>Description</title>
572
573                <para>Returns version of the postgis scripts installed in this
574                        database.</para>
575
576                <note>
577                          <para>If the output of this function doesn't match the output of
578                          <xref linkend="PostGIS_Scripts_Released" />
579                          you probably missed to properly upgrade an existing database.
580                          See the <link linkend="upgrading">Upgrading</link> section for
581                          more info.</para>
582                </note>
583
584                <para>Availability: 0.9.0</para>
585          </refsection>
586
587          <refsection>
588                <title>Examples</title>
589
590                <programlisting>SELECT PostGIS_Scripts_Installed();
591  postgis_scripts_installed
592-------------------------
593 1.5.0SVN
594(1 row)</programlisting>
595          </refsection>
596
597          <refsection>
598                <title>See Also</title>
599
600                <para><xref linkend="PostGIS_Full_Version" />, <xref linkend="PostGIS_Scripts_Released" />, <xref linkend="PostGIS_Version" /></para>
601          </refsection>
602        </refentry>
603
604        <refentry id="PostGIS_Scripts_Released">
605          <refnamediv>
606                <refname>PostGIS_Scripts_Released</refname>
607
608                <refpurpose>Returns the version number of the postgis.sql script
609                released with the installed postgis lib.</refpurpose>
610          </refnamediv>
611
612          <refsynopsisdiv>
613                <funcsynopsis>
614                  <funcprototype>
615                        <funcdef>text <function>PostGIS_Scripts_Released</function></funcdef>
616
617                        <paramdef></paramdef>
618                  </funcprototype>
619                </funcsynopsis>
620          </refsynopsisdiv>
621
622          <refsection>
623                <title>Description</title>
624
625                <para>Returns the version number of the postgis.sql script
626                released with the installed postgis lib.</para>
627
628                <note>
629                  <para>Starting with version 1.1.0 this function returns the same
630                  value of <xref linkend="PostGIS_Lib_Version" />. Kept
631                  for backward compatibility.</para>
632                </note>
633
634                <para>Availability: 0.9.0</para>
635          </refsection>
636
637          <refsection>
638                <title>Examples</title>
639
640                <programlisting>SELECT PostGIS_Scripts_Released();
641  postgis_scripts_released
642-------------------------
643 1.3.4SVN
644(1 row)</programlisting>
645          </refsection>
646
647          <refsection>
648                <title>See Also</title>
649
650                <para><xref linkend="PostGIS_Full_Version" />, <xref linkend="PostGIS_Scripts_Installed" />, <xref linkend="PostGIS_Lib_Version" /></para>
651          </refsection>
652        </refentry>
653
654        <refentry id="PostGIS_Uses_Stats">
655          <refnamediv>
656                <refname>PostGIS_Uses_Stats</refname>
657
658                <refpurpose>Returns <varname>TRUE</varname> if STATS usage has been
659                enabled.</refpurpose>
660          </refnamediv>
661
662          <refsynopsisdiv>
663                <funcsynopsis>
664                  <funcprototype>
665                        <funcdef>text <function>PostGIS_Uses_Stats</function></funcdef>
666
667                        <paramdef></paramdef>
668                  </funcprototype>
669                </funcsynopsis>
670          </refsynopsisdiv>
671
672          <refsection>
673                <title>Description</title>
674
675                <para>Returns <varname>TRUE</varname> if STATS usage has been enabled,
676                <varname>FALSE</varname> otherwise.</para>
677          </refsection>
678
679          <refsection>
680                <title>Examples</title>
681
682                <programlisting>SELECT PostGIS_Uses_Stats();
683 postgis_uses_stats
684--------------------
685 t
686(1 row)</programlisting>
687          </refsection>
688
689          <refsection>
690                <title>See Also</title>
691
692                <para><xref linkend="PostGIS_Version" /></para>
693          </refsection>
694        </refentry>
695
696        <refentry id="PostGIS_Version">
697          <refnamediv>
698                <refname>PostGIS_Version</refname>
699
700                <refpurpose>Returns PostGIS version number and compile-time
701                options.</refpurpose>
702          </refnamediv>
703
704          <refsynopsisdiv>
705                <funcsynopsis>
706                  <funcprototype>
707                        <funcdef>text <function>PostGIS_Version</function></funcdef>
708
709                        <paramdef></paramdef>
710                  </funcprototype>
711                </funcsynopsis>
712          </refsynopsisdiv>
713
714          <refsection>
715                <title>Description</title>
716
717                <para>Returns PostGIS version number and compile-time options.</para>
718          </refsection>
719
720          <refsection>
721                <title>Examples</title>
722
723                <programlisting>SELECT PostGIS_Version();
724                        postgis_version
725---------------------------------------
726 1.3 USE_GEOS=1 USE_PROJ=1 USE_STATS=1
727(1 row)</programlisting>
728          </refsection>
729
730          <refsection>
731                <title>See Also</title>
732
733                <para><xref linkend="PostGIS_Full_Version" />, <xref
734                linkend="PostGIS_GEOS_Version" />,<xref
735                linkend="PostGIS_Lib_Version" />, <xref
736                linkend="PostGIS_PROJ_Version" /></para>
737          </refsection>
738        </refentry>
739
740        <refentry id="Populate_Geometry_Columns">
741          <refnamediv>
742                <refname>Populate_Geometry_Columns</refname>
743
744                <refpurpose>Ensures geometry columns have appropriate spatial constraints
745                and exist in the <varname>geometry_columns</varname> table.</refpurpose>
746          </refnamediv>
747
748          <refsynopsisdiv>
749                <funcsynopsis>
750                  <funcprototype>
751                        <funcdef>text <function>Populate_Geometry_Columns</function></funcdef>
752
753                        <paramdef></paramdef>
754                  </funcprototype>
755
756                  <funcprototype>
757                        <funcdef>int <function>Populate_Geometry_Columns</function></funcdef>
758
759                        <paramdef><type>oid</type> <parameter>relation_oid</parameter></paramdef>
760                  </funcprototype>
761                </funcsynopsis>
762          </refsynopsisdiv>
763
764          <refsection>
765                <title>Description</title>
766
767                <para>Ensures geometry columns have appropriate spatial constraints and
768                exist in the <varname>geometry_columns</varname> table.  In particular,
769                this means that every geometry column belonging to a table has at least
770                three constraints:</para>
771
772                <itemizedlist>
773                  <listitem>
774                        <para><varname>enforce_dims_the_geom</varname> - ensures every
775                        geometry has the same dimension (see <xref
776                        linkend="ST_NDims" />)</para>
777                  </listitem>
778
779                  <listitem>
780                        <para><varname>enforce_geotype_the_geom</varname> - ensures every
781                        geometry is of the same type (see <xref
782                        linkend="GeometryType" />)</para>
783                  </listitem>
784
785                  <listitem>
786                        <para><varname>enforce_srid_the_geom</varname> - ensures every
787                        geometry is in the same projection (see <xref
788                        linkend="ST_SRID" />)</para>
789                  </listitem>
790                </itemizedlist>
791
792                <para>If a table <varname>oid</varname> is provided, this function
793                tries to determine the srid, dimension, and geometry type of all
794                geometry columns in the table, adding contraints as necessary. If
795                successful, an appropriate row is inserted into the geometry_columns
796                table, otherwise, the exception is caught and an error notice is raised
797                describing the problem.</para>
798
799                <para>If the <varname>oid</varname> of a view is provided, as with a
800                table oid, this function tries to determine the srid, dimension, and
801                type of all the geometries in the view, inserting appropriate entries
802                into the <varname>geometry_columns</varname> table, but nothing is done
803                to enforce contraints.</para>
804
805                <para>The parameterless variant is a simple wrapper for the parameterized
806                variant that first truncates and repopulates the geometry_columns table
807                for every spatial table and view in the database, adding spatial
808                contraints to tables where appropriate.  It returns a summary of the
809                number of geometry columns detected in the database and the number that
810                were inserted into the <varname>geometry_columns</varname> table.  The
811                parameterized version simply returns the number of rows inserted into
812                the <varname>geometry_columns</varname> table.</para>
813                <para>Availability: 1.4.0</para>
814          </refsection>
815
816          <refsection>
817                <title>Examples</title>
818
819                <programlisting>SELECT Populate_Geometry_Columns('public.myspatial_table'::regclass);</programlisting>
820          </refsection>
821
822          <refsection>
823                <title>See Also</title>
824
825                <para><xref linkend="Probe_Geometry_Columns" /></para>
826          </refsection>
827        </refentry>
828
829        <refentry id="Probe_Geometry_Columns">
830          <refnamediv>
831                <refname>Probe_Geometry_Columns</refname>
832
833                <refpurpose>Scans all tables with PostGIS geometry constraints and adds them to the <varname>geometry_columns</varname>
834                        table if they are not there.</refpurpose>
835          </refnamediv>
836
837          <refsynopsisdiv>
838                <funcsynopsis>
839                  <funcprototype>
840                        <funcdef>text <function>Probe_Geometry_Columns</function></funcdef>
841                        <paramdef></paramdef>
842                  </funcprototype>
843                </funcsynopsis>
844          </refsynopsisdiv>
845
846          <refsection>
847                <title>Description</title>
848
849                <para>Scans all tables with PostGIS geometry constraints and adds them to the <varname>geometry_columns</varname>
850                        table if they are not there.  Also give stats on number of inserts and already present or possibly obsolete.</para>
851                <note><para>This will usually only pick up records added by AddGeometryColumn() function.  It will not scan views so views
852                        will need to be manually added to geometry_columns table.</para></note>
853          </refsection>
854
855          <refsection>
856                <title>Examples</title>
857
858                <programlisting>SELECT Probe_Geometry_Columns();
859                        probe_geometry_columns
860---------------------------------------
861probed:6 inserted:0 conflicts:6 stale:0
862(1 row)</programlisting>
863          </refsection>
864
865          <refsection>
866                <title>See Also</title>
867
868                <para><xref linkend="AddGeometryColumn" /></para>
869          </refsection>
870        </refentry>
871
872
873        <refentry id="UpdateGeometrySRID">
874          <refnamediv>
875                <refname>UpdateGeometrySRID</refname>
876
877                <refpurpose>Updates the SRID of all features in a geometry
878                column, geometry_columns metadata and srid table constraint</refpurpose>
879          </refnamediv>
880
881          <refsynopsisdiv>
882                <funcsynopsis>
883                  <funcprototype>
884                        <funcdef>text <function>UpdateGeometrySRID</function></funcdef>
885
886                        <paramdef><type>varchar </type>
887                        <parameter>table_name</parameter></paramdef>
888
889                        <paramdef><type>varchar </type>
890                        <parameter>column_name</parameter></paramdef>
891
892                        <paramdef><type>integer </type>
893                        <parameter>srid</parameter></paramdef>
894                  </funcprototype>
895
896                  <funcprototype>
897                        <funcdef>text <function>UpdateGeometrySRID</function></funcdef>
898
899                        <paramdef><type>varchar </type>
900                        <parameter>schema_name</parameter></paramdef>
901
902                        <paramdef><type>varchar </type>
903                        <parameter>table_name</parameter></paramdef>
904
905                        <paramdef><type>varchar </type>
906                        <parameter>column_name</parameter></paramdef>
907
908                        <paramdef><type>integer </type>
909                        <parameter>srid</parameter></paramdef>
910                  </funcprototype>
911
912                  <funcprototype>
913                        <funcdef>text <function>UpdateGeometrySRID</function></funcdef>
914
915                        <paramdef><type>varchar </type>
916                        <parameter>catalog_name</parameter></paramdef>
917
918                        <paramdef><type>varchar </type>
919                        <parameter>schema_name</parameter></paramdef>
920
921                        <paramdef><type>varchar </type>
922                        <parameter>table_name</parameter></paramdef>
923
924                        <paramdef><type>varchar </type>
925                        <parameter>column_name</parameter></paramdef>
926
927                        <paramdef><type>integer </type>
928                        <parameter>srid</parameter></paramdef>
929                  </funcprototype>
930                </funcsynopsis>
931          </refsynopsisdiv>
932
933          <refsection>
934                <title>Description</title>
935
936                <para>Updates the SRID of all features in a geometry column, updating
937                constraints and reference in geometry_columns. Note: uses
938                current_schema() on schema-aware pgsql installations if schema is not
939                provided.</para>
940                <para>&Z_support;</para>
941                <para>&curve_support;</para>
942          </refsection>
943
944          <refsection>
945                <title>See Also</title>
946
947                <para><xref linkend="ST_SetSRID"/></para>
948          </refsection>
949        </refentry>
950  </sect1>
Note: See TracBrowser for help on using the repository browser.