vectorlib_pg.dox 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102
  1. /*! \page vlibPg GRASS-PostGIS data provider
  2. by GRASS Development Team (http://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 bellow are lower level subroutines, in
  18. other word these functions are not consider for usage. They are
  19. internally used by the vector library when accessing PostGIS data. The
  20. programmer should use higher level functions instead.
  21. - Vect_open_old() to open exising vector map (ie. PostGIS table when using GRASS-PostGIS data provider)
  22. - Vect_open_new() to create new vector map
  23. - Vect_close() to close vector map
  24. - Vect_rewind() to rewind the map for sequential access
  25. - Vect_read_next_line() for sequential access
  26. - Vect_read_line() for random access
  27. - Vect_write_line() to write a new feature
  28. - Vect_delete_line() to delete existing feature
  29. - Vect_rewrite_line() to modify exising feature
  30. - Vect_build() to build (pseudo-)topology
  31. Note that functions with <tt>V1_</tt> prefix access vector data
  32. without topology. Topological (pseudo-topological for simple features)
  33. access is provided by functions starting with <tt>V2_</tt> prefix.
  34. \par Open/Create PostGIS table as GRASS vector map
  35. - V1_open_old_pg()
  36. - V2_open_old_pg()
  37. - V1_open_new_pg()
  38. - V2_open_new_pg()
  39. - V1_close_pg()
  40. - V2_close_pg()
  41. \par Read feature from PostGIS table
  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 to PostGIS table
  50. - V1_write_line_pg()
  51. - V2_write_line_sfa()
  52. - V2_write_line_pg()
  53. \par Delete exising feature from PostGIS table
  54. - V1_delete_line_pg()
  55. - V2_delete_line_sfa()
  56. \par Modify existing feature from PostGIS table
  57. - V1_rewrite_line_pg()
  58. - V2_rewrite_line_sfa()
  59. \par Build topology
  60. - Vect_open_topo_pg()
  61. - Vect__build_sfa()
  62. - Vect_build_pg()
  63. \section vlibPgSeeAlso See Also
  64. - \ref vlibOgr
  65. \section vlibPgAuthors Authors
  66. Martin Landa <landa.martin gmail.com>
  67. */