index.rst 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. .. sqlc documentation master file, created by
  2. sphinx-quickstart on Mon Feb 1 23:18:36 2021.
  3. You can adapt this file completely to your liking, but it should at least
  4. contain the root `toctree` directive.
  5. sqlc Documentation
  6. ==================
  7. And lo, the Great One looked down upon the people and proclaimed:
  8. "SQL is actually pretty great"
  9. sqlc generates **fully type-safe idiomatic Go code** from SQL. Here's how it
  10. works:
  11. 1. You write SQL queries
  12. 2. You run sqlc to generate Go code that presents type-safe interfaces to those
  13. queries
  14. 3. You write application code that calls the methods sqlc generated
  15. Seriously, it's that easy. You don't have to write any boilerplate SQL querying
  16. code ever again.
  17. .. toctree::
  18. :maxdepth: 2
  19. :caption: Overview
  20. :hidden:
  21. overview/install.md
  22. .. toctree::
  23. :maxdepth: 2
  24. :caption: Tutorials
  25. :hidden:
  26. tutorials/getting-started-mysql.md
  27. tutorials/getting-started-postgresql.md
  28. .. toctree::
  29. :maxdepth: 2
  30. :caption: How-to Guides
  31. :hidden:
  32. howto/select.md
  33. howto/query_count.md
  34. howto/insert.md
  35. howto/update.md
  36. howto/delete.md
  37. howto/prepared_query.md
  38. howto/transactions.md
  39. howto/named_parameters.md
  40. howto/ddl.md
  41. howto/structs.md
  42. .. toctree::
  43. :maxdepth: 2
  44. :caption: Reference
  45. :hidden:
  46. reference/cli.md
  47. reference/config.md
  48. reference/datatypes.md
  49. reference/query-annotations.md
  50. reference/language-support.rst
  51. reference/environment-variables.md
  52. .. toctree::
  53. :maxdepth: 2
  54. :caption: Conceptual Guides
  55. :hidden:
  56. guides/development.md
  57. guides/privacy.md