Merge pull request #139 from psqlpy-python/support_dbapi

Updated docs

Author: chandr-andr

.gitignore

@@ -77,4 +77,8 @@ _load_test
 
 # JS
 node_modules
-.temp
+.temp
+node_modules/
+docs/.vuepress/.cache/
+docs/.vuepress/.temp/
+docs/.vuepress/dist/

docs/.vuepress/config.ts

@@ -1,15 +1,14 @@
 import { defineUserConfig } from "vuepress";
 import { hopeTheme } from "vuepress-theme-hope";
 import sidebar from "./sidebar.js";
-
-import { viteBundler } from '@vuepress/bundler-vite'
+import { markdownTabPlugin } from '@vuepress/plugin-markdown-tab'
 
 export default defineUserConfig({
   lang: "en-US",
   title: "PSQLPy",
   description: "PSQLPy Documentation",
 
-  bundler: viteBundler(),
+  // bundler: viteBundler(),
 
   theme: hopeTheme({
     repo: "psqlpy-python/psqlpy",
@@ -22,22 +21,20 @@ export default defineUserConfig({
 
     hostname: "https://psqlpy-python.github.io/",
 
+    markdown: {
+      tabs: true,
+      mermaid: true,
+      chartjs: true,
+    },
+
     plugins: {
       readingTime: false,
-
       copyCode: {
         showInMobile: true,
       },
 
-      searchPro: {
+      slimsearch: {
         indexContent: true,
-        autoSuggestions: false,
-      },
-
-      mdEnhance: {
-        tabs: true,
-        mermaid: true,
-        chart: true,
       },
 
       sitemap: {

docs/.vuepress/sidebar.ts

@@ -23,6 +23,7 @@ export default sidebar({
         "connection",
         "transaction",
         "cursor",
+        "prepared_statement",
         "listener",
         "results",
         "exceptions",

docs/.vuepress/styles/config.scss

@@ -0,0 +1,3 @@
+$code-dark-theme: dracula;
+$code-light-theme: one-light;
+$theme-color: #264934;

docs/.vuepress/styles/index.scss

@@ -0,0 +1,19 @@
+// place your custom styles here
+.vp-site-name {
+    visibility: hidden;
+}
+
+.vp-hero-info {
+    img {
+        max-width: 60% !important;
+        padding: 1rem;
+    }
+}
+
+.vp-hero-title {
+  font-size: 3rem;
+}
+
+.vp-actions {
+    align-items: flex-end;
+}

docs/.vuepress/styles/palette.scss

@@ -0,0 +1 @@
+// you can change colors here

docs/.vuepress/theme.ts

@@ -27,7 +27,7 @@ However, if you have application and database located on different machines, you
 ## Local Database
 ::: tabs
 @tab Simple Connection Select
-::: chart Simple Connection Select
+::: chartjs Simple Connection Select
 
 ```json
 {
@@ -80,7 +80,7 @@ However, if you have application and database located on different machines, you
 }
 ```
 @tab Hard Connection Select
-::: chart Hard Connection Select
+::: chartjs Hard Connection Select
 
 ```json
 {
@@ -133,7 +133,7 @@ However, if you have application and database located on different machines, you
 }
 ```
 @tab Combined Connection Query
-::: chart Combined Connection Query
+::: chartjs Combined Connection Query
 
 ```json
 {
@@ -186,7 +186,7 @@ However, if you have application and database located on different machines, you
 }
 ```
 @tab Simple Transaction Select
-::: chart Simple Transaction Select
+::: chartjs Simple Transaction Select
 
 ```json
 {
@@ -239,7 +239,7 @@ However, if you have application and database located on different machines, you
 }
 ```
 @tab Hard Transaction Select
-::: chart Hard Transaction Select
+::: chartjs Hard Transaction Select
 
 ```json
 {
@@ -292,7 +292,7 @@ However, if you have application and database located on different machines, you
 }
 ```
 @tab Combined Transaction Query
-::: chart Combined Transaction Query
+::: chartjs Combined Transaction Query
 
 ```json
 {
@@ -349,7 +349,7 @@ However, if you have application and database located on different machines, you
 ## External Database
 ::: tabs
 @tab Simple Connection Select
-::: chart Simple Connection Select
+::: chartjs Simple Connection Select
 
 ```json
 {
@@ -403,7 +403,7 @@ However, if you have application and database located on different machines, you
 ```
 
 @tab Hard Connection Select
-::: chart Hard Connection Select
+::: chartjs Hard Connection Select
 
 ```json
 {
@@ -457,7 +457,7 @@ However, if you have application and database located on different machines, you
 ```
 
 @tab Combined Connection Query
-::: chart Combined Connection Query
+::: chartjs Combined Connection Query
 
 ```json
 {
@@ -511,7 +511,7 @@ However, if you have application and database located on different machines, you
 ```
 
 @tab Simple Transaction Select
-::: chart Simple Transaction Select
+::: chartjs Simple Transaction Select
 
 ```json
 {
@@ -565,7 +565,7 @@ However, if you have application and database located on different machines, you
 ```
 
 @tab Hard Transaction Select
-::: chart Hard Transaction Select
+::: chartjs Hard Transaction Select
 
 ```json
 {
@@ -619,7 +619,7 @@ However, if you have application and database located on different machines, you
 ```
 
 @tab Combined Transaction Query
-::: chart Combined Transaction Query
+::: chartjs Combined Transaction Query
 
 ```json
 {

docs/benchmarks.md

@@ -5,11 +5,11 @@ title: Components
 ## Components
 - `ConnectionPool`: holds connections in itself and give them when requested.
 - `ConnectionPoolBuilder`: Chainable builder for `ConnectionPool`, for people who prefer it over big initialization.
-- `Connection`: represents single database connection, can be retrieved from `ConnectionPool`.
+- `Connection`: represents single database connection, can be retrieved from `ConnectionPool` or created with `connect` method.
 - `Transaction`: represents database transaction, can be made from `Connection`.
-- `Cursor`: represents database cursor, can be made from `Transaction`.
+- `Cursor`: represents database cursor, can be made from `Connection`, `Transaction` and `PreparedStatement`.
+- `PreparedStatement`: represents PostgreSQL prepared statement.
 - `Listener`: object to work with [LISTEN](https://www.postgresql.org/docs/current/sql-listen.html)/[NOTIFY](https://www.postgresql.org/docs/current/sql-notify.html) functionality, can be mode from `ConnectionPool`.
 - `QueryResult`: represents list of results from database.
 - `SingleQueryResult`: represents single result from the database.
 - `Exceptions`: we have some custom exceptions.
-