You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

120 lines
3.8 KiB

  1. ==========
  2. SQL Export
  3. ==========
  4. .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  5. !! This file is generated by oca-gen-addon-readme !!
  6. !! changes will be overwritten. !!
  7. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  8. .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
  9. :target: https://odoo-community.org/page/development-status
  10. :alt: Beta
  11. .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  13. :alt: License: AGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
  15. :target: https://github.com/OCA/server-tools/tree/12.0/sql_export
  16. :alt: OCA/server-tools
  17. .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
  18. :target: https://translation.odoo-community.org/projects/server-tools-12-0/server-tools-12-0-sql_export
  19. :alt: Translate me on Weblate
  20. .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
  21. :target: https://runbot.odoo-community.org/runbot/149/12.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. Allow to export data in csv files FROM sql requests.
  25. There are some restrictions in the sql query, you can only read datas.
  26. No update, deletion or creation are possible.
  27. A new menu named Export is created.
  28. **Table of contents**
  29. .. contents::
  30. :local:
  31. Usage
  32. =====
  33. Dashboards > Sql Export
  34. **Specific use with parameters**
  35. - `%(company_id)s` allows to set in the query the company id of the user
  36. - `%(user_id)s` allows to set in the query the user id
  37. - for any created field with `Sql Export Variables` menu, you can use it with `%(x_field_example)s` syntax
  38. (Limitation for relational fields)
  39. Known issues / Roadmap
  40. ======================
  41. * Some words are prohibited and can't be used is the query in anyways, even in
  42. a select query:
  43. - delete
  44. - drop
  45. - insert
  46. - alter
  47. - truncate
  48. - execute
  49. - create
  50. - update
  51. See sql_request_abstract module to fix this issue.
  52. * checking SQL request by execution and rollback is disabled in this module
  53. since variables features has been introduced. This can be fixed by
  54. overloading _prepare_request_check_execution() function.
  55. * Move modules sql_request_abstract and sql_export to oca/reporting-engine
  56. Bug Tracker
  57. ===========
  58. Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
  59. In case of trouble, please check there if your issue has already been reported.
  60. If you spotted it first, help us smashing it by providing a detailed and welcomed
  61. `feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20sql_export%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  62. Do not contact contributors directly about support or help with technical issues.
  63. Credits
  64. =======
  65. Authors
  66. ~~~~~~~
  67. * Akretion
  68. Contributors
  69. ~~~~~~~~~~~~
  70. * `Akretion <https://www.akretion.com>`_:
  71. * Florian da Costa <florian.dacosta@akretion.com>
  72. * Mourad EL HADJ MIMOUNE <mourad.elhadj.mimoune@akretion.com>
  73. * Benoît GUILLOT <benoit.guillot@akretion.com>
  74. * `Eficent <https://www.eficent.com>`_:
  75. * Aaron Henriquez <ahenriquez@eficent.com>
  76. Maintainers
  77. ~~~~~~~~~~~
  78. This module is maintained by the OCA.
  79. .. image:: https://odoo-community.org/logo.png
  80. :alt: Odoo Community Association
  81. :target: https://odoo-community.org
  82. OCA, or the Odoo Community Association, is a nonprofit organization whose
  83. mission is to support the collaborative development of Odoo features and
  84. promote its widespread use.
  85. This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/12.0/sql_export>`_ project on GitHub.
  86. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.