vectorlib_pg.dox 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  1. /*! \page vlibPg GRASS-PostGIS data provider
  2. by GRASS Development Team (https://grass.osgeo.org)
  3. \tableofcontents
  4. \section vlibPgInro Introduction
  5. <b>GRASS-PostGIS data provider</b> allows GRASS vector library to read and
  6. write PostGIS data directly without any external library (like in the
  7. case of \ref vlibOgr). GRASS-PostGIS data provider is implemented
  8. using <a
  9. href="http://www.postgresql.org/docs/9.2/static/libpq.html">libpq
  10. library</a>.
  11. Note that GRASS-PostGIS data provider is compiled only when GRASS is
  12. configured with <tt>--with-postgres</tt> switch.
  13. See the <a
  14. href="http://trac.osgeo.org/grass/wiki/Grass7/VectorLib/PostGISInterface">trac
  15. page</a> for more info.
  16. \section vlibFn List of functions
  17. Note that the functions listed below are lower level subroutines, in
  18. other word these functions are not considered to be part of public
  19. API. They are internally used by the vector library when accessing
  20. PostGIS data. The programmer should use higher level functions
  21. instead.
  22. - Vect_open_old() to open existing vector map (ie. PostGIS table when using GRASS-PostGIS data provider)
  23. - Vect_open_new() to create new vector map
  24. - Vect_close() to close vector map
  25. - Vect_rewind() to rewind the map for sequential access
  26. - Vect_read_next_line() for sequential access
  27. - Vect_read_line() for random access
  28. - Vect_write_line() to write a new feature
  29. - Vect_delete_line() to delete existing feature
  30. - Vect_rewrite_line() to modify existing feature
  31. - Vect_build() to build (pseudo-)topology
  32. Note that functions with <tt>V1_</tt> prefix access vector data
  33. without topology. Topological (pseudo-topological for simple features)
  34. access is provided by functions starting with <tt>V2_</tt> prefix.
  35. \par Open/Create PostGIS table as GRASS vector map
  36. - V1_open_old_pg()
  37. - V2_open_old_pg()
  38. - V1_open_new_pg()
  39. - V1_close_pg()
  40. - V2_close_pg()
  41. \par Read access
  42. - V1_rewind_pg()
  43. - V2_rewind_pg()
  44. - V1_read_next_line_pg()
  45. - V2_read_next_line_pg()
  46. - V1_read_line_pg()
  47. - V2_read_line_sfa()
  48. - V2_read_line_pg()
  49. \par Write new feature or topological element
  50. - V1_write_line_pg()
  51. - V2_write_line_sfa() - write new simple feature
  52. - V2_write_line_pg() - write new topological element in PostGIS Topology schema
  53. \par Delete existing feature or topological element
  54. - V1_delete_line_pg()
  55. - V2_delete_line_sfa() - delete simple feature
  56. - V2_delete_line_pg() - delete topological element from PostGIS Topology schema
  57. \par Modify existing feature or topological element
  58. - V1_rewrite_line_pg()
  59. - V2_rewrite_line_sfa() - modify simple feature
  60. - V2_rewrite_line_pg() - modify topological element from PostGIS Topology schema
  61. \par Build topology
  62. - Vect_open_topo_pg()
  63. - Vect__build_sfa()
  64. - Vect_build_pg()
  65. \section vlibPgSeeAlso See Also
  66. - \ref vlibOgr
  67. \section vlibPgAuthors Authors
  68. Martin Landa <landa.martin gmail.com>
  69. */