From dd74d5e952442c547140fadf792588357ba050df Mon Sep 17 00:00:00 2001 From: Sam Date: Sun, 8 Mar 2026 19:54:54 +0100 Subject: [PATCH] doc update --- docs/docusaurus/.docusaurus/client-modules.js | 8 +- .../default/p/aw-sql-974.json | 2 +- .../p/aw-sql-category-classes-422.json | 2 +- .../default/site-docs-intro-md-0e3.json | 8 +- docs/docusaurus/.docusaurus/globalData.json | 10 ++ docs/docusaurus/.docusaurus/registry.js | 72 ++++---- docs/docusaurus/.docusaurus/routes.js | 53 +++++- .../.docusaurus/routesChunkNames.json | 163 ++++++++++++------ .../docusaurus/.docusaurus/site-metadata.json | 4 +- .../docs/example-db/_category_.json | 2 +- docs/docusaurus/docs/guide/_category_.json | 8 + docs/docusaurus/docs/guide/intro.md | 45 +++++ docs/docusaurus/docs/intro.md | 2 +- docs/docusaurus/docs/typedefs/_category_.json | 2 +- 14 files changed, 276 insertions(+), 105 deletions(-) create mode 100644 docs/docusaurus/docs/guide/_category_.json create mode 100644 docs/docusaurus/docs/guide/intro.md diff --git a/docs/docusaurus/.docusaurus/client-modules.js b/docs/docusaurus/.docusaurus/client-modules.js index ac2f263..ba79a36 100644 --- a/docs/docusaurus/.docusaurus/client-modules.js +++ b/docs/docusaurus/.docusaurus/client-modules.js @@ -1,6 +1,6 @@ export default [ - require("D:\\_SharedStorage\\Git Projects\\awSQL_refined\\docs\\docusaurus\\node_modules\\infima\\dist\\css\\default\\default.css"), - require("D:\\_SharedStorage\\Git Projects\\awSQL_refined\\docs\\docusaurus\\node_modules\\@docusaurus\\theme-classic\\lib\\prism-include-languages"), - require("D:\\_SharedStorage\\Git Projects\\awSQL_refined\\docs\\docusaurus\\node_modules\\@docusaurus\\theme-classic\\lib\\nprogress"), - require("D:\\_SharedStorage\\Git Projects\\awSQL_refined\\docs\\docusaurus\\src\\css\\custom.css"), + require("D:\\_SharedStorage\\git_projects\\awSQL_refined\\docs\\docusaurus\\node_modules\\infima\\dist\\css\\default\\default.css"), + require("D:\\_SharedStorage\\git_projects\\awSQL_refined\\docs\\docusaurus\\node_modules\\@docusaurus\\theme-classic\\lib\\prism-include-languages"), + require("D:\\_SharedStorage\\git_projects\\awSQL_refined\\docs\\docusaurus\\node_modules\\@docusaurus\\theme-classic\\lib\\nprogress"), + require("D:\\_SharedStorage\\git_projects\\awSQL_refined\\docs\\docusaurus\\src\\css\\custom.css"), ]; diff --git a/docs/docusaurus/.docusaurus/docusaurus-plugin-content-docs/default/p/aw-sql-974.json b/docs/docusaurus/.docusaurus/docusaurus-plugin-content-docs/default/p/aw-sql-974.json index 3fb4a11..d71694a 100644 --- a/docs/docusaurus/.docusaurus/docusaurus-plugin-content-docs/default/p/aw-sql-974.json +++ b/docs/docusaurus/.docusaurus/docusaurus-plugin-content-docs/default/p/aw-sql-974.json @@ -1 +1 @@ -{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"defaultSidebar":[{"type":"link","label":"Introduction","href":"/awSQL/","docId":"intro","unlisted":false},{"type":"category","label":"Classes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"awSQL","href":"/awSQL/classes/awsql","docId":"classes/awsql","unlisted":false},{"type":"link","label":"Instance","href":"/awSQL/classes/instance","docId":"classes/instance","unlisted":false},{"type":"link","label":"Select","href":"/awSQL/classes/select","docId":"classes/select","unlisted":false},{"type":"link","label":"Insert","href":"/awSQL/classes/insert","docId":"classes/insert","unlisted":false},{"type":"link","label":"Delete","href":"/awSQL/classes/delete","docId":"classes/delete","unlisted":false},{"type":"link","label":"Update","href":"/awSQL/classes/update","docId":"classes/update","unlisted":false},{"type":"link","label":"Structure","href":"/awSQL/classes/structure","docId":"classes/structure","unlisted":false},{"type":"link","label":"CreateTable","href":"/awSQL/classes/create-table","docId":"classes/create-table","unlisted":false},{"type":"link","label":"AlterTable","href":"/awSQL/classes/alter-table","docId":"classes/alter-table","unlisted":false}],"href":"/awSQL/category/classes"},{"type":"category","label":"Typedefs","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"OkPacket","href":"/awSQL/typedefs/okpacket","docId":"typedefs/okpacket","unlisted":false},{"type":"link","label":"ColumnStructure","href":"/awSQL/typedefs/column-structure","docId":"typedefs/column-structure","unlisted":false},{"type":"link","label":"ConstraintOptions","href":"/awSQL/typedefs/constraint-options","docId":"typedefs/constraint-options","unlisted":false}],"href":"/awSQL/category/typedefs"},{"type":"category","label":"Example Database","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Table: Categories","href":"/awSQL/example-db/Categories","docId":"example-db/Categories","unlisted":false},{"type":"link","label":"Table: Customers","href":"/awSQL/example-db/Customers","docId":"example-db/Customers","unlisted":false},{"type":"link","label":"Table: Employees","href":"/awSQL/example-db/Employees","docId":"example-db/Employees","unlisted":false},{"type":"link","label":"Table: OrderDetails","href":"/awSQL/example-db/OrderDetails","docId":"example-db/OrderDetails","unlisted":false},{"type":"link","label":"Table: Orders","href":"/awSQL/example-db/Orders","docId":"example-db/Orders","unlisted":false},{"type":"link","label":"Table: Products","href":"/awSQL/example-db/Products","docId":"example-db/Products","unlisted":false},{"type":"link","label":"Table: Shippers","href":"/awSQL/example-db/Shippers","docId":"example-db/Shippers","unlisted":false},{"type":"link","label":"Table: Suppliers","href":"/awSQL/example-db/Suppliers","docId":"example-db/Suppliers","unlisted":false}],"href":"/awSQL/category/example-database"}]},"docs":{"classes/alter-table":{"id":"classes/alter-table","title":"AlterTable","description":"Modifies an existing table by altering its structure.","sidebar":"defaultSidebar"},"classes/awsql":{"id":"classes/awsql","title":"awSQL","description":"The default exported module that holds and manages all database instances globally.","sidebar":"defaultSidebar"},"classes/create-table":{"id":"classes/create-table","title":"CreateTable","description":"Creates a new table with a defined structure.","sidebar":"defaultSidebar"},"classes/delete":{"id":"classes/delete","title":"Delete","description":"Performs a query to delete rows from a table.","sidebar":"defaultSidebar"},"classes/insert":{"id":"classes/insert","title":"Insert","description":"Performs a query to insert new data into a table.","sidebar":"defaultSidebar"},"classes/instance":{"id":"classes/instance","title":"Instance","description":"Handles connection data and serves as the gateway for performing queries.","sidebar":"defaultSidebar"},"classes/select":{"id":"classes/select","title":"Select","description":"Performs a query to retrieve data from a table.","sidebar":"defaultSidebar"},"classes/structure":{"id":"classes/structure","title":"Structure","description":"Defines a new table structure for managing columns efficiently.","sidebar":"defaultSidebar"},"classes/update":{"id":"classes/update","title":"Update","description":"Executes a query to update data in a table.","sidebar":"defaultSidebar"},"example-db/Categories":{"id":"example-db/Categories","title":"Table: Categories","description":"| CategoryID | CategoryName | Description |","sidebar":"defaultSidebar"},"example-db/Customers":{"id":"example-db/Customers","title":"Table: Customers","description":"| CustomerID | CustomerName | ContactName | Address | City | PostalCode | Country |","sidebar":"defaultSidebar"},"example-db/Employees":{"id":"example-db/Employees","title":"Table: Employees","description":"| EmployeeID | LastName | FirstName | BirthDate | Photo | Notes |","sidebar":"defaultSidebar"},"example-db/OrderDetails":{"id":"example-db/OrderDetails","title":"Table: OrderDetails","description":"| OrderDetailID | OrderID | ProductID | Quantity |","sidebar":"defaultSidebar"},"example-db/Orders":{"id":"example-db/Orders","title":"Table: Orders","description":"| OrderID | CustomerID | EmployeeID | OrderDate | ShipperID |","sidebar":"defaultSidebar"},"example-db/Products":{"id":"example-db/Products","title":"Table: Products","description":"| ProductID | ProductName | SupplierID | CategoryID | Unit | Price |","sidebar":"defaultSidebar"},"example-db/Shippers":{"id":"example-db/Shippers","title":"Table: Shippers","description":"| ShipperID | ShipperName | Phone |","sidebar":"defaultSidebar"},"example-db/Suppliers":{"id":"example-db/Suppliers","title":"Table: Suppliers","description":"| SupplierID | SupplierName | ContactName | Address | City | PostalCode | Country | Phone |","sidebar":"defaultSidebar"},"intro":{"id":"intro","title":"Introduction","description":"awSQL is a fast and reliable database query tool designed to:","sidebar":"defaultSidebar"},"typedefs/column-structure":{"id":"typedefs/column-structure","title":"ColumnStructure","description":"Type: Object","sidebar":"defaultSidebar"},"typedefs/constraint-options":{"id":"typedefs/constraint-options","title":"ConstraintOptions","description":"Type: Object","sidebar":"defaultSidebar"},"typedefs/okpacket":{"id":"typedefs/okpacket","title":"OkPacket","description":"Object","sidebar":"defaultSidebar"}}}} \ No newline at end of file +{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"defaultSidebar":[{"type":"link","label":"Introduction","href":"/awSQL/","docId":"intro","unlisted":false},{"type":"category","label":"Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Setup & Basic Steps","href":"/awSQL/guide/intro","docId":"guide/intro","unlisted":false}],"href":"/awSQL/category/guide"},{"type":"category","label":"Classes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"awSQL","href":"/awSQL/classes/awsql","docId":"classes/awsql","unlisted":false},{"type":"link","label":"Instance","href":"/awSQL/classes/instance","docId":"classes/instance","unlisted":false},{"type":"link","label":"Select","href":"/awSQL/classes/select","docId":"classes/select","unlisted":false},{"type":"link","label":"Insert","href":"/awSQL/classes/insert","docId":"classes/insert","unlisted":false},{"type":"link","label":"Delete","href":"/awSQL/classes/delete","docId":"classes/delete","unlisted":false},{"type":"link","label":"Update","href":"/awSQL/classes/update","docId":"classes/update","unlisted":false},{"type":"link","label":"Structure","href":"/awSQL/classes/structure","docId":"classes/structure","unlisted":false},{"type":"link","label":"CreateTable","href":"/awSQL/classes/create-table","docId":"classes/create-table","unlisted":false},{"type":"link","label":"AlterTable","href":"/awSQL/classes/alter-table","docId":"classes/alter-table","unlisted":false}],"href":"/awSQL/category/classes"},{"type":"category","label":"Typedefs","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"OkPacket","href":"/awSQL/typedefs/okpacket","docId":"typedefs/okpacket","unlisted":false},{"type":"link","label":"ColumnStructure","href":"/awSQL/typedefs/column-structure","docId":"typedefs/column-structure","unlisted":false},{"type":"link","label":"ConstraintOptions","href":"/awSQL/typedefs/constraint-options","docId":"typedefs/constraint-options","unlisted":false}],"href":"/awSQL/category/typedefs"},{"type":"category","label":"Example Database","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Table: Categories","href":"/awSQL/example-db/Categories","docId":"example-db/Categories","unlisted":false},{"type":"link","label":"Table: Customers","href":"/awSQL/example-db/Customers","docId":"example-db/Customers","unlisted":false},{"type":"link","label":"Table: Employees","href":"/awSQL/example-db/Employees","docId":"example-db/Employees","unlisted":false},{"type":"link","label":"Table: OrderDetails","href":"/awSQL/example-db/OrderDetails","docId":"example-db/OrderDetails","unlisted":false},{"type":"link","label":"Table: Orders","href":"/awSQL/example-db/Orders","docId":"example-db/Orders","unlisted":false},{"type":"link","label":"Table: Products","href":"/awSQL/example-db/Products","docId":"example-db/Products","unlisted":false},{"type":"link","label":"Table: Shippers","href":"/awSQL/example-db/Shippers","docId":"example-db/Shippers","unlisted":false},{"type":"link","label":"Table: Suppliers","href":"/awSQL/example-db/Suppliers","docId":"example-db/Suppliers","unlisted":false}],"href":"/awSQL/category/example-database"}]},"docs":{"classes/alter-table":{"id":"classes/alter-table","title":"AlterTable","description":"Modifies an existing table by altering its structure.","sidebar":"defaultSidebar"},"classes/awsql":{"id":"classes/awsql","title":"awSQL","description":"The default exported module that holds and manages all database instances globally.","sidebar":"defaultSidebar"},"classes/create-table":{"id":"classes/create-table","title":"CreateTable","description":"Creates a new table with a defined structure.","sidebar":"defaultSidebar"},"classes/delete":{"id":"classes/delete","title":"Delete","description":"Performs a query to delete rows from a table.","sidebar":"defaultSidebar"},"classes/insert":{"id":"classes/insert","title":"Insert","description":"Performs a query to insert new data into a table.","sidebar":"defaultSidebar"},"classes/instance":{"id":"classes/instance","title":"Instance","description":"Handles connection data and serves as the gateway for performing queries.","sidebar":"defaultSidebar"},"classes/select":{"id":"classes/select","title":"Select","description":"Performs a query to retrieve data from a table.","sidebar":"defaultSidebar"},"classes/structure":{"id":"classes/structure","title":"Structure","description":"Defines a new table structure for managing columns efficiently.","sidebar":"defaultSidebar"},"classes/update":{"id":"classes/update","title":"Update","description":"Executes a query to update data in a table.","sidebar":"defaultSidebar"},"example-db/Categories":{"id":"example-db/Categories","title":"Table: Categories","description":"| CategoryID | CategoryName | Description |","sidebar":"defaultSidebar"},"example-db/Customers":{"id":"example-db/Customers","title":"Table: Customers","description":"| CustomerID | CustomerName | ContactName | Address | City | PostalCode | Country |","sidebar":"defaultSidebar"},"example-db/Employees":{"id":"example-db/Employees","title":"Table: Employees","description":"| EmployeeID | LastName | FirstName | BirthDate | Photo | Notes |","sidebar":"defaultSidebar"},"example-db/OrderDetails":{"id":"example-db/OrderDetails","title":"Table: OrderDetails","description":"| OrderDetailID | OrderID | ProductID | Quantity |","sidebar":"defaultSidebar"},"example-db/Orders":{"id":"example-db/Orders","title":"Table: Orders","description":"| OrderID | CustomerID | EmployeeID | OrderDate | ShipperID |","sidebar":"defaultSidebar"},"example-db/Products":{"id":"example-db/Products","title":"Table: Products","description":"| ProductID | ProductName | SupplierID | CategoryID | Unit | Price |","sidebar":"defaultSidebar"},"example-db/Shippers":{"id":"example-db/Shippers","title":"Table: Shippers","description":"| ShipperID | ShipperName | Phone |","sidebar":"defaultSidebar"},"example-db/Suppliers":{"id":"example-db/Suppliers","title":"Table: Suppliers","description":"| SupplierID | SupplierName | ContactName | Address | City | PostalCode | Country | Phone |","sidebar":"defaultSidebar"},"guide/intro":{"id":"guide/intro","title":"Setup & Basic Steps","description":"---","sidebar":"defaultSidebar"},"intro":{"id":"intro","title":"Introduction","description":"awSQL is a fast and reliable database query tool designed to:","sidebar":"defaultSidebar"},"typedefs/column-structure":{"id":"typedefs/column-structure","title":"ColumnStructure","description":"Type: Object","sidebar":"defaultSidebar"},"typedefs/constraint-options":{"id":"typedefs/constraint-options","title":"ConstraintOptions","description":"Type: Object","sidebar":"defaultSidebar"},"typedefs/okpacket":{"id":"typedefs/okpacket","title":"OkPacket","description":"Object","sidebar":"defaultSidebar"}}}} \ No newline at end of file diff --git a/docs/docusaurus/.docusaurus/docusaurus-plugin-content-docs/default/p/aw-sql-category-classes-422.json b/docs/docusaurus/.docusaurus/docusaurus-plugin-content-docs/default/p/aw-sql-category-classes-422.json index 43d059f..6c43ad9 100644 --- a/docs/docusaurus/.docusaurus/docusaurus-plugin-content-docs/default/p/aw-sql-category-classes-422.json +++ b/docs/docusaurus/.docusaurus/docusaurus-plugin-content-docs/default/p/aw-sql-category-classes-422.json @@ -1 +1 @@ -{"categoryGeneratedIndex":{"title":"Classes","description":"Here you can find all classes awSQL uses","slug":"/category/classes","permalink":"/awSQL/category/classes","sidebar":"defaultSidebar","navigation":{"previous":{"title":"Introduction","permalink":"/awSQL/"},"next":{"title":"awSQL","permalink":"/awSQL/classes/awsql"}}}} \ No newline at end of file +{"categoryGeneratedIndex":{"title":"Classes","description":"Here you can find all classes awSQL uses","slug":"/category/classes","permalink":"/awSQL/category/classes","sidebar":"defaultSidebar","navigation":{"previous":{"title":"Setup & Basic Steps","permalink":"/awSQL/guide/intro"},"next":{"title":"awSQL","permalink":"/awSQL/classes/awsql"}}}} \ No newline at end of file diff --git a/docs/docusaurus/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-intro-md-0e3.json b/docs/docusaurus/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-intro-md-0e3.json index 1e4f63b..2be289b 100644 --- a/docs/docusaurus/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-intro-md-0e3.json +++ b/docs/docusaurus/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-intro-md-0e3.json @@ -10,14 +10,14 @@ "unlisted": false, "tags": [], "version": "current", - "sidebarPosition": 1, + "sidebarPosition": 0, "frontMatter": { - "sidebar_position": 1, + "sidebar_position": 0, "slug": "/" }, "sidebar": "defaultSidebar", "next": { - "title": "Classes", - "permalink": "/awSQL/category/classes" + "title": "Guide", + "permalink": "/awSQL/category/guide" } } \ No newline at end of file diff --git a/docs/docusaurus/.docusaurus/globalData.json b/docs/docusaurus/.docusaurus/globalData.json index a663fb0..17dc2c9 100644 --- a/docs/docusaurus/.docusaurus/globalData.json +++ b/docs/docusaurus/.docusaurus/globalData.json @@ -95,6 +95,11 @@ "path": "/awSQL/example-db/Suppliers", "sidebar": "defaultSidebar" }, + { + "id": "guide/intro", + "path": "/awSQL/guide/intro", + "sidebar": "defaultSidebar" + }, { "id": "intro", "path": "/awSQL/", @@ -115,6 +120,11 @@ "path": "/awSQL/typedefs/okpacket", "sidebar": "defaultSidebar" }, + { + "id": "/category/guide", + "path": "/awSQL/category/guide", + "sidebar": "defaultSidebar" + }, { "id": "/category/classes", "path": "/awSQL/category/classes", diff --git a/docs/docusaurus/.docusaurus/registry.js b/docs/docusaurus/.docusaurus/registry.js index 2031670..5edadac 100644 --- a/docs/docusaurus/.docusaurus/registry.js +++ b/docs/docusaurus/.docusaurus/registry.js @@ -1,32 +1,42 @@ export default { - "0e384e19": [() => import(/* webpackChunkName: "0e384e19" */ "@site/docs/intro.md"), "@site/docs/intro.md", require.resolveWeak("@site/docs/intro.md")], - "14eb3368": [() => import(/* webpackChunkName: "14eb3368" */ "@theme/DocCategoryGeneratedIndexPage"), "@theme/DocCategoryGeneratedIndexPage", require.resolveWeak("@theme/DocCategoryGeneratedIndexPage")], - "17896441": [() => import(/* webpackChunkName: "17896441" */ "@theme/DocItem"), "@theme/DocItem", require.resolveWeak("@theme/DocItem")], - "23e85390": [() => import(/* webpackChunkName: "23e85390" */ "@site/docs/classes/select.md"), "@site/docs/classes/select.md", require.resolveWeak("@site/docs/classes/select.md")], - "24da6c76": [() => import(/* webpackChunkName: "24da6c76" */ "@site/docs/classes/structure.md"), "@site/docs/classes/structure.md", require.resolveWeak("@site/docs/classes/structure.md")], - "29b1da97": [() => import(/* webpackChunkName: "29b1da97" */ "@site/docs/example-db/Employees.md"), "@site/docs/example-db/Employees.md", require.resolveWeak("@site/docs/example-db/Employees.md")], - "2ab12074": [() => import(/* webpackChunkName: "2ab12074" */ "@site/docs/classes/update.md"), "@site/docs/classes/update.md", require.resolveWeak("@site/docs/classes/update.md")], - "3ee20894": [() => import(/* webpackChunkName: "3ee20894" */ "@site/docs/typedefs/column-structure.md"), "@site/docs/typedefs/column-structure.md", require.resolveWeak("@site/docs/typedefs/column-structure.md")], - "4aa16d27": [() => import(/* webpackChunkName: "4aa16d27" */ "@site/docs/example-db/Products.md"), "@site/docs/example-db/Products.md", require.resolveWeak("@site/docs/example-db/Products.md")], - "58de6db1": [() => import(/* webpackChunkName: "58de6db1" */ "@site/docs/classes/insert.md"), "@site/docs/classes/insert.md", require.resolveWeak("@site/docs/classes/insert.md")], - "5e95c892": [() => import(/* webpackChunkName: "5e95c892" */ "@theme/DocsRoot"), "@theme/DocsRoot", require.resolveWeak("@theme/DocsRoot")], - "62179925": [() => import(/* webpackChunkName: "62179925" */ "@site/docs/example-db/Suppliers.md"), "@site/docs/example-db/Suppliers.md", require.resolveWeak("@site/docs/example-db/Suppliers.md")], - "7617dfbd": [() => import(/* webpackChunkName: "7617dfbd" */ "@site/docs/classes/instance.md"), "@site/docs/classes/instance.md", require.resolveWeak("@site/docs/classes/instance.md")], - "763f4ffe": [() => import(/* webpackChunkName: "763f4ffe" */ "@site/docs/classes/create-table.md"), "@site/docs/classes/create-table.md", require.resolveWeak("@site/docs/classes/create-table.md")], - "7e36430b": [() => import(/* webpackChunkName: "7e36430b" */ "@site/docs/classes/delete.md"), "@site/docs/classes/delete.md", require.resolveWeak("@site/docs/classes/delete.md")], - "80ddc423": [() => import(/* webpackChunkName: "80ddc423" */ "@site/docs/example-db/Orders.md"), "@site/docs/example-db/Orders.md", require.resolveWeak("@site/docs/example-db/Orders.md")], - "a52c2351": [() => import(/* webpackChunkName: "a52c2351" */ "@generated/docusaurus-plugin-content-docs/default/p/aw-sql-category-classes-422.json"), "@generated/docusaurus-plugin-content-docs/default/p/aw-sql-category-classes-422.json", require.resolveWeak("@generated/docusaurus-plugin-content-docs/default/p/aw-sql-category-classes-422.json")], - "a6964e95": [() => import(/* webpackChunkName: "a6964e95" */ "@site/docs/typedefs/constraint-options.md"), "@site/docs/typedefs/constraint-options.md", require.resolveWeak("@site/docs/typedefs/constraint-options.md")], - "a7bd4aaa": [() => import(/* webpackChunkName: "a7bd4aaa" */ "@theme/DocVersionRoot"), "@theme/DocVersionRoot", require.resolveWeak("@theme/DocVersionRoot")], - "a94703ab": [() => import(/* webpackChunkName: "a94703ab" */ "@theme/DocRoot"), "@theme/DocRoot", require.resolveWeak("@theme/DocRoot")], - "aba21aa0": [() => import(/* webpackChunkName: "aba21aa0" */ "@generated/docusaurus-plugin-content-docs/default/__plugin.json"), "@generated/docusaurus-plugin-content-docs/default/__plugin.json", require.resolveWeak("@generated/docusaurus-plugin-content-docs/default/__plugin.json")], - "af19f545": [() => import(/* webpackChunkName: "af19f545" */ "@generated/docusaurus-plugin-content-docs/default/p/aw-sql-category-example-database-60a.json"), "@generated/docusaurus-plugin-content-docs/default/p/aw-sql-category-example-database-60a.json", require.resolveWeak("@generated/docusaurus-plugin-content-docs/default/p/aw-sql-category-example-database-60a.json")], - "b4c15e47": [() => import(/* webpackChunkName: "b4c15e47" */ "@site/docs/example-db/Shippers.md"), "@site/docs/example-db/Shippers.md", require.resolveWeak("@site/docs/example-db/Shippers.md")], - "b5207823": [() => import(/* webpackChunkName: "b5207823" */ "@site/docs/typedefs/okpacket.md"), "@site/docs/typedefs/okpacket.md", require.resolveWeak("@site/docs/typedefs/okpacket.md")], - "c8769413": [() => import(/* webpackChunkName: "c8769413" */ "@site/docs/example-db/Customers.md"), "@site/docs/example-db/Customers.md", require.resolveWeak("@site/docs/example-db/Customers.md")], - "c8ec3168": [() => import(/* webpackChunkName: "c8ec3168" */ "@site/docs/classes/alter-table.md"), "@site/docs/classes/alter-table.md", require.resolveWeak("@site/docs/classes/alter-table.md")], - "d7af1896": [() => import(/* webpackChunkName: "d7af1896" */ "@site/docs/classes/awsql.md"), "@site/docs/classes/awsql.md", require.resolveWeak("@site/docs/classes/awsql.md")], - "da8fdd4d": [() => import(/* webpackChunkName: "da8fdd4d" */ "@site/docs/example-db/Categories.md"), "@site/docs/example-db/Categories.md", require.resolveWeak("@site/docs/example-db/Categories.md")], - "e2f8b94f": [() => import(/* webpackChunkName: "e2f8b94f" */ "@generated/docusaurus-plugin-content-docs/default/p/aw-sql-974.json"), "@generated/docusaurus-plugin-content-docs/default/p/aw-sql-974.json", require.resolveWeak("@generated/docusaurus-plugin-content-docs/default/p/aw-sql-974.json")], - "e393803f": [() => import(/* webpackChunkName: "e393803f" */ "@generated/docusaurus-plugin-content-docs/default/p/aw-sql-category-typedefs-f23.json"), "@generated/docusaurus-plugin-content-docs/default/p/aw-sql-category-typedefs-f23.json", require.resolveWeak("@generated/docusaurus-plugin-content-docs/default/p/aw-sql-category-typedefs-f23.json")], - "f8062fff": [() => import(/* webpackChunkName: "f8062fff" */ "@site/docs/example-db/OrderDetails.md"), "@site/docs/example-db/OrderDetails.md", require.resolveWeak("@site/docs/example-db/OrderDetails.md")],}; + "__comp---theme-debug-config-23-a-2ff": [() => import(/* webpackChunkName: "__comp---theme-debug-config-23-a-2ff" */ "@theme/DebugConfig"), "@theme/DebugConfig", require.resolveWeak("@theme/DebugConfig")], + "__comp---theme-debug-contentba-8-ce7": [() => import(/* webpackChunkName: "__comp---theme-debug-contentba-8-ce7" */ "@theme/DebugContent"), "@theme/DebugContent", require.resolveWeak("@theme/DebugContent")], + "__comp---theme-debug-global-dataede-0fa": [() => import(/* webpackChunkName: "__comp---theme-debug-global-dataede-0fa" */ "@theme/DebugGlobalData"), "@theme/DebugGlobalData", require.resolveWeak("@theme/DebugGlobalData")], + "__comp---theme-debug-registry-679-501": [() => import(/* webpackChunkName: "__comp---theme-debug-registry-679-501" */ "@theme/DebugRegistry"), "@theme/DebugRegistry", require.resolveWeak("@theme/DebugRegistry")], + "__comp---theme-debug-routes-946-699": [() => import(/* webpackChunkName: "__comp---theme-debug-routes-946-699" */ "@theme/DebugRoutes"), "@theme/DebugRoutes", require.resolveWeak("@theme/DebugRoutes")], + "__comp---theme-debug-site-metadata-68-e-3d4": [() => import(/* webpackChunkName: "__comp---theme-debug-site-metadata-68-e-3d4" */ "@theme/DebugSiteMetadata"), "@theme/DebugSiteMetadata", require.resolveWeak("@theme/DebugSiteMetadata")], + "__comp---theme-doc-category-generated-index-page-14-e-640": [() => import(/* webpackChunkName: "__comp---theme-doc-category-generated-index-page-14-e-640" */ "@theme/DocCategoryGeneratedIndexPage"), "@theme/DocCategoryGeneratedIndexPage", require.resolveWeak("@theme/DocCategoryGeneratedIndexPage")], + "__comp---theme-doc-item-178-a40": [() => import(/* webpackChunkName: "__comp---theme-doc-item-178-a40" */ "@theme/DocItem"), "@theme/DocItem", require.resolveWeak("@theme/DocItem")], + "__comp---theme-doc-roota-94-67a": [() => import(/* webpackChunkName: "__comp---theme-doc-roota-94-67a" */ "@theme/DocRoot"), "@theme/DocRoot", require.resolveWeak("@theme/DocRoot")], + "__comp---theme-doc-version-roota-7-b-5de": [() => import(/* webpackChunkName: "__comp---theme-doc-version-roota-7-b-5de" */ "@theme/DocVersionRoot"), "@theme/DocVersionRoot", require.resolveWeak("@theme/DocVersionRoot")], + "__comp---theme-docs-root-5-e-9-0b6": [() => import(/* webpackChunkName: "__comp---theme-docs-root-5-e-9-0b6" */ "@theme/DocsRoot"), "@theme/DocsRoot", require.resolveWeak("@theme/DocsRoot")], + "__props---aw-sql-category-classesa-52-d2f": [() => import(/* webpackChunkName: "__props---aw-sql-category-classesa-52-d2f" */ "@generated/docusaurus-plugin-content-docs/default/p/aw-sql-category-classes-422.json"), "@generated/docusaurus-plugin-content-docs/default/p/aw-sql-category-classes-422.json", require.resolveWeak("@generated/docusaurus-plugin-content-docs/default/p/aw-sql-category-classes-422.json")], + "__props---aw-sql-category-example-databaseaf-1-524": [() => import(/* webpackChunkName: "__props---aw-sql-category-example-databaseaf-1-524" */ "@generated/docusaurus-plugin-content-docs/default/p/aw-sql-category-example-database-60a.json"), "@generated/docusaurus-plugin-content-docs/default/p/aw-sql-category-example-database-60a.json", require.resolveWeak("@generated/docusaurus-plugin-content-docs/default/p/aw-sql-category-example-database-60a.json")], + "__props---aw-sql-category-guide-74-c-299": [() => import(/* webpackChunkName: "__props---aw-sql-category-guide-74-c-299" */ "@generated/docusaurus-plugin-content-docs/default/p/aw-sql-category-guide-c36.json"), "@generated/docusaurus-plugin-content-docs/default/p/aw-sql-category-guide-c36.json", require.resolveWeak("@generated/docusaurus-plugin-content-docs/default/p/aw-sql-category-guide-c36.json")], + "__props---aw-sql-category-typedefse-39-0f9": [() => import(/* webpackChunkName: "__props---aw-sql-category-typedefse-39-0f9" */ "@generated/docusaurus-plugin-content-docs/default/p/aw-sql-category-typedefs-f23.json"), "@generated/docusaurus-plugin-content-docs/default/p/aw-sql-category-typedefs-f23.json", require.resolveWeak("@generated/docusaurus-plugin-content-docs/default/p/aw-sql-category-typedefs-f23.json")], + "__props---aw-sql-docusaurus-debug-content-66-f-60c": [() => import(/* webpackChunkName: "__props---aw-sql-docusaurus-debug-content-66-f-60c" */ "@generated/docusaurus-plugin-debug/default/p/aw-sql-docusaurus-debug-content-62f.json"), "@generated/docusaurus-plugin-debug/default/p/aw-sql-docusaurus-debug-content-62f.json", require.resolveWeak("@generated/docusaurus-plugin-debug/default/p/aw-sql-docusaurus-debug-content-62f.json")], + "__props---aw-sql-e-2-f-827": [() => import(/* webpackChunkName: "__props---aw-sql-e-2-f-827" */ "@generated/docusaurus-plugin-content-docs/default/p/aw-sql-974.json"), "@generated/docusaurus-plugin-content-docs/default/p/aw-sql-974.json", require.resolveWeak("@generated/docusaurus-plugin-content-docs/default/p/aw-sql-974.json")], + "content---aw-sql-0-e-3-1bb": [() => import(/* webpackChunkName: "content---aw-sql-0-e-3-1bb" */ "@site/docs/intro.md"), "@site/docs/intro.md", require.resolveWeak("@site/docs/intro.md")], + "content---aw-sql-classes-alter-tablec-8-e-69f": [() => import(/* webpackChunkName: "content---aw-sql-classes-alter-tablec-8-e-69f" */ "@site/docs/classes/alter-table.md"), "@site/docs/classes/alter-table.md", require.resolveWeak("@site/docs/classes/alter-table.md")], + "content---aw-sql-classes-awsqld-7-a-19a": [() => import(/* webpackChunkName: "content---aw-sql-classes-awsqld-7-a-19a" */ "@site/docs/classes/awsql.md"), "@site/docs/classes/awsql.md", require.resolveWeak("@site/docs/classes/awsql.md")], + "content---aw-sql-classes-create-table-763-889": [() => import(/* webpackChunkName: "content---aw-sql-classes-create-table-763-889" */ "@site/docs/classes/create-table.md"), "@site/docs/classes/create-table.md", require.resolveWeak("@site/docs/classes/create-table.md")], + "content---aw-sql-classes-delete-7-e-3-76b": [() => import(/* webpackChunkName: "content---aw-sql-classes-delete-7-e-3-76b" */ "@site/docs/classes/delete.md"), "@site/docs/classes/delete.md", require.resolveWeak("@site/docs/classes/delete.md")], + "content---aw-sql-classes-insert-58-d-d90": [() => import(/* webpackChunkName: "content---aw-sql-classes-insert-58-d-d90" */ "@site/docs/classes/insert.md"), "@site/docs/classes/insert.md", require.resolveWeak("@site/docs/classes/insert.md")], + "content---aw-sql-classes-instance-761-58c": [() => import(/* webpackChunkName: "content---aw-sql-classes-instance-761-58c" */ "@site/docs/classes/instance.md"), "@site/docs/classes/instance.md", require.resolveWeak("@site/docs/classes/instance.md")], + "content---aw-sql-classes-select-23-e-4d1": [() => import(/* webpackChunkName: "content---aw-sql-classes-select-23-e-4d1" */ "@site/docs/classes/select.md"), "@site/docs/classes/select.md", require.resolveWeak("@site/docs/classes/select.md")], + "content---aw-sql-classes-structure-24-d-e1f": [() => import(/* webpackChunkName: "content---aw-sql-classes-structure-24-d-e1f" */ "@site/docs/classes/structure.md"), "@site/docs/classes/structure.md", require.resolveWeak("@site/docs/classes/structure.md")], + "content---aw-sql-classes-update-2-ab-944": [() => import(/* webpackChunkName: "content---aw-sql-classes-update-2-ab-944" */ "@site/docs/classes/update.md"), "@site/docs/classes/update.md", require.resolveWeak("@site/docs/classes/update.md")], + "content---aw-sql-example-db-categoriesda-8-26c": [() => import(/* webpackChunkName: "content---aw-sql-example-db-categoriesda-8-26c" */ "@site/docs/example-db/Categories.md"), "@site/docs/example-db/Categories.md", require.resolveWeak("@site/docs/example-db/Categories.md")], + "content---aw-sql-example-db-customersc-87-edf": [() => import(/* webpackChunkName: "content---aw-sql-example-db-customersc-87-edf" */ "@site/docs/example-db/Customers.md"), "@site/docs/example-db/Customers.md", require.resolveWeak("@site/docs/example-db/Customers.md")], + "content---aw-sql-example-db-employees-29-b-9c7": [() => import(/* webpackChunkName: "content---aw-sql-example-db-employees-29-b-9c7" */ "@site/docs/example-db/Employees.md"), "@site/docs/example-db/Employees.md", require.resolveWeak("@site/docs/example-db/Employees.md")], + "content---aw-sql-example-db-order-detailsf-80-973": [() => import(/* webpackChunkName: "content---aw-sql-example-db-order-detailsf-80-973" */ "@site/docs/example-db/OrderDetails.md"), "@site/docs/example-db/OrderDetails.md", require.resolveWeak("@site/docs/example-db/OrderDetails.md")], + "content---aw-sql-example-db-orders-80-d-6a5": [() => import(/* webpackChunkName: "content---aw-sql-example-db-orders-80-d-6a5" */ "@site/docs/example-db/Orders.md"), "@site/docs/example-db/Orders.md", require.resolveWeak("@site/docs/example-db/Orders.md")], + "content---aw-sql-example-db-products-4-aa-d67": [() => import(/* webpackChunkName: "content---aw-sql-example-db-products-4-aa-d67" */ "@site/docs/example-db/Products.md"), "@site/docs/example-db/Products.md", require.resolveWeak("@site/docs/example-db/Products.md")], + "content---aw-sql-example-db-shippersb-4-c-a5e": [() => import(/* webpackChunkName: "content---aw-sql-example-db-shippersb-4-c-a5e" */ "@site/docs/example-db/Shippers.md"), "@site/docs/example-db/Shippers.md", require.resolveWeak("@site/docs/example-db/Shippers.md")], + "content---aw-sql-example-db-suppliers-621-e92": [() => import(/* webpackChunkName: "content---aw-sql-example-db-suppliers-621-e92" */ "@site/docs/example-db/Suppliers.md"), "@site/docs/example-db/Suppliers.md", require.resolveWeak("@site/docs/example-db/Suppliers.md")], + "content---aw-sql-guide-intro-83-b-936": [() => import(/* webpackChunkName: "content---aw-sql-guide-intro-83-b-936" */ "@site/docs/guide/intro.md"), "@site/docs/guide/intro.md", require.resolveWeak("@site/docs/guide/intro.md")], + "content---aw-sql-typedefs-column-structure-3-ee-735": [() => import(/* webpackChunkName: "content---aw-sql-typedefs-column-structure-3-ee-735" */ "@site/docs/typedefs/column-structure.md"), "@site/docs/typedefs/column-structure.md", require.resolveWeak("@site/docs/typedefs/column-structure.md")], + "content---aw-sql-typedefs-constraint-optionsa-69-ec9": [() => import(/* webpackChunkName: "content---aw-sql-typedefs-constraint-optionsa-69-ec9" */ "@site/docs/typedefs/constraint-options.md"), "@site/docs/typedefs/constraint-options.md", require.resolveWeak("@site/docs/typedefs/constraint-options.md")], + "content---aw-sql-typedefs-okpacketb-52-840": [() => import(/* webpackChunkName: "content---aw-sql-typedefs-okpacketb-52-840" */ "@site/docs/typedefs/okpacket.md"), "@site/docs/typedefs/okpacket.md", require.resolveWeak("@site/docs/typedefs/okpacket.md")], + "plugin---aw-sql-aba-d91": [() => import(/* webpackChunkName: "plugin---aw-sql-aba-d91" */ "@generated/docusaurus-plugin-content-docs/default/__plugin.json"), "@generated/docusaurus-plugin-content-docs/default/__plugin.json", require.resolveWeak("@generated/docusaurus-plugin-content-docs/default/__plugin.json")], + "plugin---aw-sql-docusaurus-debugb-38-e62": [() => import(/* webpackChunkName: "plugin---aw-sql-docusaurus-debugb-38-e62" */ "@generated/docusaurus-plugin-debug/default/__plugin.json"), "@generated/docusaurus-plugin-debug/default/__plugin.json", require.resolveWeak("@generated/docusaurus-plugin-debug/default/__plugin.json")],}; diff --git a/docs/docusaurus/.docusaurus/routes.js b/docs/docusaurus/.docusaurus/routes.js index 3bf2461..a52d815 100644 --- a/docs/docusaurus/.docusaurus/routes.js +++ b/docs/docusaurus/.docusaurus/routes.js @@ -2,17 +2,52 @@ import React from 'react'; import ComponentCreator from '@docusaurus/ComponentCreator'; export default [ + { + path: '/awSQL/__docusaurus/debug', + component: ComponentCreator('/awSQL/__docusaurus/debug', '53e'), + exact: true + }, + { + path: '/awSQL/__docusaurus/debug/config', + component: ComponentCreator('/awSQL/__docusaurus/debug/config', '599'), + exact: true + }, + { + path: '/awSQL/__docusaurus/debug/content', + component: ComponentCreator('/awSQL/__docusaurus/debug/content', 'cea'), + exact: true + }, + { + path: '/awSQL/__docusaurus/debug/globalData', + component: ComponentCreator('/awSQL/__docusaurus/debug/globalData', '2a0'), + exact: true + }, + { + path: '/awSQL/__docusaurus/debug/metadata', + component: ComponentCreator('/awSQL/__docusaurus/debug/metadata', 'd72'), + exact: true + }, + { + path: '/awSQL/__docusaurus/debug/registry', + component: ComponentCreator('/awSQL/__docusaurus/debug/registry', '1e7'), + exact: true + }, + { + path: '/awSQL/__docusaurus/debug/routes', + component: ComponentCreator('/awSQL/__docusaurus/debug/routes', 'e44'), + exact: true + }, { path: '/awSQL/', - component: ComponentCreator('/awSQL/', 'af5'), + component: ComponentCreator('/awSQL/', '5b9'), routes: [ { path: '/awSQL/', - component: ComponentCreator('/awSQL/', '7d7'), + component: ComponentCreator('/awSQL/', '70a'), routes: [ { path: '/awSQL/', - component: ComponentCreator('/awSQL/', '266'), + component: ComponentCreator('/awSQL/', '3be'), routes: [ { path: '/awSQL/category/classes', @@ -26,6 +61,12 @@ export default [ exact: true, sidebar: "defaultSidebar" }, + { + path: '/awSQL/category/guide', + component: ComponentCreator('/awSQL/category/guide', '10d'), + exact: true, + sidebar: "defaultSidebar" + }, { path: '/awSQL/category/typedefs', component: ComponentCreator('/awSQL/category/typedefs', '812'), @@ -134,6 +175,12 @@ export default [ exact: true, sidebar: "defaultSidebar" }, + { + path: '/awSQL/guide/intro', + component: ComponentCreator('/awSQL/guide/intro', '639'), + exact: true, + sidebar: "defaultSidebar" + }, { path: '/awSQL/typedefs/column-structure', component: ComponentCreator('/awSQL/typedefs/column-structure', '93b'), diff --git a/docs/docusaurus/.docusaurus/routesChunkNames.json b/docs/docusaurus/.docusaurus/routesChunkNames.json index 07acd54..857870b 100644 --- a/docs/docusaurus/.docusaurus/routesChunkNames.json +++ b/docs/docusaurus/.docusaurus/routesChunkNames.json @@ -1,111 +1,162 @@ { - "/awSQL/-af5": { - "__comp": "5e95c892", + "/awSQL/__docusaurus/debug-53e": { + "__comp": "__comp---theme-debug-config-23-a-2ff", "__context": { - "plugin": "aba21aa0" + "plugin": "plugin---aw-sql-docusaurus-debugb-38-e62" } }, - "/awSQL/-7d7": { - "__comp": "a7bd4aaa", - "__props": "e2f8b94f" + "/awSQL/__docusaurus/debug/config-599": { + "__comp": "__comp---theme-debug-config-23-a-2ff", + "__context": { + "plugin": "plugin---aw-sql-docusaurus-debugb-38-e62" + } }, - "/awSQL/-266": { - "__comp": "a94703ab" + "/awSQL/__docusaurus/debug/content-cea": { + "__comp": "__comp---theme-debug-contentba-8-ce7", + "__context": { + "plugin": "plugin---aw-sql-docusaurus-debugb-38-e62" + }, + "__props": "__props---aw-sql-docusaurus-debug-content-66-f-60c" + }, + "/awSQL/__docusaurus/debug/globalData-2a0": { + "__comp": "__comp---theme-debug-global-dataede-0fa", + "__context": { + "plugin": "plugin---aw-sql-docusaurus-debugb-38-e62" + } + }, + "/awSQL/__docusaurus/debug/metadata-d72": { + "__comp": "__comp---theme-debug-site-metadata-68-e-3d4", + "__context": { + "plugin": "plugin---aw-sql-docusaurus-debugb-38-e62" + } + }, + "/awSQL/__docusaurus/debug/registry-1e7": { + "__comp": "__comp---theme-debug-registry-679-501", + "__context": { + "plugin": "plugin---aw-sql-docusaurus-debugb-38-e62" + } + }, + "/awSQL/__docusaurus/debug/routes-e44": { + "__comp": "__comp---theme-debug-routes-946-699", + "__context": { + "plugin": "plugin---aw-sql-docusaurus-debugb-38-e62" + } + }, + "/awSQL/-5b9": { + "__comp": "__comp---theme-docs-root-5-e-9-0b6", + "__context": { + "plugin": "plugin---aw-sql-aba-d91" + } + }, + "/awSQL/-70a": { + "__comp": "__comp---theme-doc-version-roota-7-b-5de", + "__props": "__props---aw-sql-e-2-f-827" + }, + "/awSQL/-3be": { + "__comp": "__comp---theme-doc-roota-94-67a" }, "/awSQL/category/classes-4b4": { - "__comp": "14eb3368", - "__props": "a52c2351" + "__comp": "__comp---theme-doc-category-generated-index-page-14-e-640", + "__props": "__props---aw-sql-category-classesa-52-d2f" }, "/awSQL/category/example-database-427": { - "__comp": "14eb3368", - "__props": "af19f545" + "__comp": "__comp---theme-doc-category-generated-index-page-14-e-640", + "__props": "__props---aw-sql-category-example-databaseaf-1-524" + }, + "/awSQL/category/guide-10d": { + "__comp": "__comp---theme-doc-category-generated-index-page-14-e-640", + "__props": "__props---aw-sql-category-guide-74-c-299" }, "/awSQL/category/typedefs-812": { - "__comp": "14eb3368", - "__props": "e393803f" + "__comp": "__comp---theme-doc-category-generated-index-page-14-e-640", + "__props": "__props---aw-sql-category-typedefse-39-0f9" }, "/awSQL/classes/alter-table-838": { - "__comp": "17896441", - "content": "c8ec3168" + "__comp": "__comp---theme-doc-item-178-a40", + "content": "content---aw-sql-classes-alter-tablec-8-e-69f" }, "/awSQL/classes/awsql-62f": { - "__comp": "17896441", - "content": "d7af1896" + "__comp": "__comp---theme-doc-item-178-a40", + "content": "content---aw-sql-classes-awsqld-7-a-19a" }, "/awSQL/classes/create-table-e6d": { - "__comp": "17896441", - "content": "763f4ffe" + "__comp": "__comp---theme-doc-item-178-a40", + "content": "content---aw-sql-classes-create-table-763-889" }, "/awSQL/classes/delete-079": { - "__comp": "17896441", - "content": "7e36430b" + "__comp": "__comp---theme-doc-item-178-a40", + "content": "content---aw-sql-classes-delete-7-e-3-76b" }, "/awSQL/classes/insert-e8b": { - "__comp": "17896441", - "content": "58de6db1" + "__comp": "__comp---theme-doc-item-178-a40", + "content": "content---aw-sql-classes-insert-58-d-d90" }, "/awSQL/classes/instance-928": { - "__comp": "17896441", - "content": "7617dfbd" + "__comp": "__comp---theme-doc-item-178-a40", + "content": "content---aw-sql-classes-instance-761-58c" }, "/awSQL/classes/select-06d": { - "__comp": "17896441", - "content": "23e85390" + "__comp": "__comp---theme-doc-item-178-a40", + "content": "content---aw-sql-classes-select-23-e-4d1" }, "/awSQL/classes/structure-0a8": { - "__comp": "17896441", - "content": "24da6c76" + "__comp": "__comp---theme-doc-item-178-a40", + "content": "content---aw-sql-classes-structure-24-d-e1f" }, "/awSQL/classes/update-d2e": { - "__comp": "17896441", - "content": "2ab12074" + "__comp": "__comp---theme-doc-item-178-a40", + "content": "content---aw-sql-classes-update-2-ab-944" }, "/awSQL/example-db/Categories-591": { - "__comp": "17896441", - "content": "da8fdd4d" + "__comp": "__comp---theme-doc-item-178-a40", + "content": "content---aw-sql-example-db-categoriesda-8-26c" }, "/awSQL/example-db/Customers-015": { - "__comp": "17896441", - "content": "c8769413" + "__comp": "__comp---theme-doc-item-178-a40", + "content": "content---aw-sql-example-db-customersc-87-edf" }, "/awSQL/example-db/Employees-487": { - "__comp": "17896441", - "content": "29b1da97" + "__comp": "__comp---theme-doc-item-178-a40", + "content": "content---aw-sql-example-db-employees-29-b-9c7" }, "/awSQL/example-db/OrderDetails-9f0": { - "__comp": "17896441", - "content": "f8062fff" + "__comp": "__comp---theme-doc-item-178-a40", + "content": "content---aw-sql-example-db-order-detailsf-80-973" }, "/awSQL/example-db/Orders-2d4": { - "__comp": "17896441", - "content": "80ddc423" + "__comp": "__comp---theme-doc-item-178-a40", + "content": "content---aw-sql-example-db-orders-80-d-6a5" }, "/awSQL/example-db/Products-fe7": { - "__comp": "17896441", - "content": "4aa16d27" + "__comp": "__comp---theme-doc-item-178-a40", + "content": "content---aw-sql-example-db-products-4-aa-d67" }, "/awSQL/example-db/Shippers-157": { - "__comp": "17896441", - "content": "b4c15e47" + "__comp": "__comp---theme-doc-item-178-a40", + "content": "content---aw-sql-example-db-shippersb-4-c-a5e" }, "/awSQL/example-db/Suppliers-961": { - "__comp": "17896441", - "content": "62179925" + "__comp": "__comp---theme-doc-item-178-a40", + "content": "content---aw-sql-example-db-suppliers-621-e92" + }, + "/awSQL/guide/intro-639": { + "__comp": "__comp---theme-doc-item-178-a40", + "content": "content---aw-sql-guide-intro-83-b-936" }, "/awSQL/typedefs/column-structure-93b": { - "__comp": "17896441", - "content": "3ee20894" + "__comp": "__comp---theme-doc-item-178-a40", + "content": "content---aw-sql-typedefs-column-structure-3-ee-735" }, "/awSQL/typedefs/constraint-options-75a": { - "__comp": "17896441", - "content": "a6964e95" + "__comp": "__comp---theme-doc-item-178-a40", + "content": "content---aw-sql-typedefs-constraint-optionsa-69-ec9" }, "/awSQL/typedefs/okpacket-e87": { - "__comp": "17896441", - "content": "b5207823" + "__comp": "__comp---theme-doc-item-178-a40", + "content": "content---aw-sql-typedefs-okpacketb-52-840" }, "/awSQL/-4a2": { - "__comp": "17896441", - "content": "0e384e19" + "__comp": "__comp---theme-doc-item-178-a40", + "content": "content---aw-sql-0-e-3-1bb" } } \ No newline at end of file diff --git a/docs/docusaurus/.docusaurus/site-metadata.json b/docs/docusaurus/.docusaurus/site-metadata.json index 3f1e018..2d5f64a 100644 --- a/docs/docusaurus/.docusaurus/site-metadata.json +++ b/docs/docusaurus/.docusaurus/site-metadata.json @@ -17,9 +17,9 @@ "name": "@docusaurus/plugin-content-pages", "version": "3.7.0" }, - "docusaurus-plugin-sitemap": { + "docusaurus-plugin-debug": { "type": "package", - "name": "@docusaurus/plugin-sitemap", + "name": "@docusaurus/plugin-debug", "version": "3.7.0" }, "docusaurus-plugin-svgr": { diff --git a/docs/docusaurus/docs/example-db/_category_.json b/docs/docusaurus/docs/example-db/_category_.json index 015ae1c..9a1d0f1 100644 --- a/docs/docusaurus/docs/example-db/_category_.json +++ b/docs/docusaurus/docs/example-db/_category_.json @@ -1,6 +1,6 @@ { "label": "Example Database", - "position": 3, + "position": 4, "link": { "type": "generated-index", "description": "Here you can find the tables of the database used for the examples" diff --git a/docs/docusaurus/docs/guide/_category_.json b/docs/docusaurus/docs/guide/_category_.json new file mode 100644 index 0000000..448f125 --- /dev/null +++ b/docs/docusaurus/docs/guide/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Guide", + "position": 1, + "link": { + "type": "generated-index", + "description": "A walkthrough guide for awSQL" + } +} diff --git a/docs/docusaurus/docs/guide/intro.md b/docs/docusaurus/docs/guide/intro.md new file mode 100644 index 0000000..c01a4ca --- /dev/null +++ b/docs/docusaurus/docs/guide/intro.md @@ -0,0 +1,45 @@ +--- +sidebar_position: 1 +--- + +# Setup & Basic Steps + +--- + +## Connecting + +```js title="main.js" + +const {awSQL} = require("awsql"); + +const instance = awSQL.createInstance("myhost.com", // Server + "awsql", // Username + "mypass", // Password + { + isDefault: true, // Should be default instance + ssl: true // Use ssl + }); + +instance.connect().then((e) => { + console.log(e); // Connected to myhost.com with user awsql +}); + +``` + +--- + +## Creating a Table + +Now we want to create a basic table with the following columns: + +| Name | Type | Allow-`NULL`? | Key | Default-Value | Extra | +| -- | -- | -- | -- | -- | -- | +| `id` | int | No | `PRI` | - | `auto_increment` | +| `name` | text | Yes | - | - | - | +| `surname` | text | Yes | - | - | - | + +```js main.js + +const newStructure + +``` \ No newline at end of file diff --git a/docs/docusaurus/docs/intro.md b/docs/docusaurus/docs/intro.md index 0a2a957..fe49f52 100644 --- a/docs/docusaurus/docs/intro.md +++ b/docs/docusaurus/docs/intro.md @@ -1,5 +1,5 @@ --- -sidebar_position: 1 +sidebar_position: 0 slug: / --- diff --git a/docs/docusaurus/docs/typedefs/_category_.json b/docs/docusaurus/docs/typedefs/_category_.json index 59f7885..e25e503 100644 --- a/docs/docusaurus/docs/typedefs/_category_.json +++ b/docs/docusaurus/docs/typedefs/_category_.json @@ -1,6 +1,6 @@ { "label": "Typedefs", - "position": 2, + "position": 3, "link": { "type": "generated-index", "description": "Here you can find all type definitions used by awSQL"