docs/start.html at main · DBConnector/docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
<!DOCTYPE html SYSTEM "about:legacy-compat">
<html lang="en-US" data-preset="contrast" data-primary-color="#307FFF"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="built-on" content="2025-06-01T16:35:17.4930573"><title>Getting Started | DBConnector</title><script type="application/json" id="virtual-toc-data">[]</script><script type="application/json" id="topic-shortcuts"></script><link href="https://resources.jetbrains.com/writerside/apidoc/6.22.0-b776/app.css" rel="stylesheet"><meta name="msapplication-TileColor" content="#000000"><link rel="apple-touch-icon" sizes="180x180" href="https://jetbrains.com/apple-touch-icon.png"><link rel="icon" type="image/png" sizes="32x32" href="https://jetbrains.com/favicon-32x32.png"><link rel="icon" type="image/png" sizes="16x16" href="https://jetbrains.com/favicon-16x16.png"><meta name="msapplication-TileImage" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-144x144.png"><meta name="msapplication-square70x70logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-70x70.png"><meta name="msapplication-square150x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-150x150.png"><meta name="msapplication-wide310x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x150.png"><meta name="msapplication-square310x310logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x310.png"><meta name="image" content=""><!-- Open Graph --><meta property="og:title" content="Getting Started | DBConnector"><meta property="og:description" content=""><meta property="og:image" content=""><meta property="og:site_name" content="DBConnector Help"><meta property="og:type" content="website"><meta property="og:locale" content="en_US"><meta property="og:url" content="writerside-documentation/start.html"><!-- End Open Graph --><!-- Twitter Card --><meta name="twitter:card" content="summary_large_image"><meta name="twitter:site" content=""><meta name="twitter:title" content="Getting Started | DBConnector"><meta name="twitter:description" content=""><meta name="twitter:creator" content=""><meta name="twitter:image:src" content=""><!-- End Twitter Card --><!-- Schema.org WebPage --><script type="application/ld+json">{
    "@context": "http://schema.org",
    "@type": "WebPage",
    "@id": "writerside-documentation/start.html#webpage",
    "url": "writerside-documentation/start.html",
    "name": "Getting Started | DBConnector",
    "description": "",
    "image": "",
    "inLanguage":"en-US"
}</script><!-- End Schema.org --><!-- Schema.org WebSite --><script type="application/ld+json">{
    "@type": "WebSite",
    "@id": "writerside-documentation/#website",
    "url": "writerside-documentation/",
    "name": "DBConnector Help"
}</script><!-- End Schema.org --></head><body data-id="start" data-main-title="Getting Started" data-article-props="{&quot;seeAlsoStyle&quot;:&quot;links&quot;}" data-template="article" data-breadcrumbs=""><div class="wrapper"><main class="panel _main"><header class="panel__header"><div class="container"><h3>DBConnector  Help</h3><div class="panel-trigger"></div></div></header><section class="panel__content"><div class="container"><article class="article" data-shortcut-switcher="inactive"><h1 data-toc="start" id="start.md">Getting Started</h1><p id="k4zqaq_3"><span class="control" id="k4zqaq_18">It only takes five steps to go from initialization to connection!</span></p><ol class="list _decimal" id="k4zqaq_4" type="1"><li class="list__item" id="k4zqaq_19"><p id="k4zqaq_20">Add AxolotlDev Repository</p></li></ol><p id="k4zqaq_5"><span class="control" id="k4zqaq_21">Add the private repository</span></p><div class="tabs" id="k4zqaq_6" data-anchors="[k4zqaq_22,k4zqaq_23,k4zqaq_24]"><div class="tabs__content" data-gtm="tab" id="k4zqaq_22" data-title="Maven"><div class="code-block" data-lang="markup" data-title="XML">
      &lt;repositories&gt;
        &lt;repository&gt;
          &lt;id&gt;axolotldev-repo&lt;/id&gt;
          &lt;url&gt;https://repo.axolotldev.me/repository/maven-public/&lt;/url&gt;
        &lt;/repository&gt;
      &lt;/repositories&gt;
    </div></div><div class="tabs__content" data-gtm="tab" id="k4zqaq_23" data-title="Gradle (Groovy DSL)"><div class="code-block" data-lang="gradle" data-title="Gradle">
        repositories {
            maven {
                url &quot;https://repo.axolotldev.me/repository/maven-public/&quot;
            }
        }
    </div></div><div class="tabs__content" data-gtm="tab" id="k4zqaq_24" data-title="Gradle Kotlin DSL"><div class="code-block" data-lang="kotlin" data-title="Kotlin">
        repositories {
            maven {
                url = uri(&quot;https://repo.axolotldev.me/repository/maven-public/&quot;)
            }
        }
    </div></div></div><ol class="list _decimal" id="k4zqaq_7" type="1" start="2"><li class="list__item" id="k4zqaq_28"><p id="k4zqaq_29">Load the Core Component</p></li></ol><figure id="k4zqaq_8"><img alt="Current Version for Core library" src="https://img.shields.io/nexus/r/me.axolotldev.dbconnector/Core?server=https://repo.axolotldev.me/&amp;label=Current%20Version" title="Current Version for Core library"></figure><div class="tabs" id="k4zqaq_9" data-anchors="[k4zqaq_30,k4zqaq_31,k4zqaq_32]"><div class="tabs__content" data-gtm="tab" id="k4zqaq_30" data-title="Maven"><div class="code-block" data-lang="markup" data-title="XML">
        &lt;dependency&gt;
            &lt;groupId&gt;me.axolotldev.dbconnector&lt;/groupId&gt;
            &lt;artifactId&gt;Core&lt;/artifactId&gt;
            &lt;version&gt;x.y.z&lt;/version&gt;
        &lt;/dependency&gt;
    </div></div><div class="tabs__content" data-gtm="tab" id="k4zqaq_31" data-title="Gradle (Groovy DSL)"><div class="code-block" data-lang="gradle" data-title="Gradle">implementation 'me.axolotldev.dbconnector:Core:x.y.z@jar'</div></div><div class="tabs__content" data-gtm="tab" id="k4zqaq_32" data-title="Gradle Kotlin DSL"><div class="code-block" data-lang="kotlin" data-title="Kotlin">implementation(&quot;me.axolotldev.dbconnector:Core:x.y.z@jar&quot;)</div></div></div><ol class="list _decimal" id="k4zqaq_10" type="1" start="3"><li class="list__item" id="k4zqaq_36"><p id="k4zqaq_37">Choose the Appropriate Database Connector</p></li></ol><p id="k4zqaq_11">Please refer to the <a href="version.html#database-drivers" id="k4zqaq_38" data-tooltip="Officially provided drivers ready for direct use. Simply install the one for your target database.">available database drivers</a>.</p><div class="tabs" id="k4zqaq_12" data-anchors="[k4zqaq_39,k4zqaq_40,k4zqaq_41]"><div class="tabs__content" data-gtm="tab" id="k4zqaq_39" data-title="Maven"><div class="code-block" data-lang="markup" data-title="XML">
        &lt;dependency&gt;
            &lt;groupId&gt;me.axolotldev.dbconnector&lt;/groupId&gt;
            &lt;artifactId&gt;xxxDriver&lt;/artifactId&gt;
            &lt;version&gt;x.y.z&lt;/version&gt;
        &lt;/dependency&gt;
    </div></div><div class="tabs__content" data-gtm="tab" id="k4zqaq_40" data-title="Gradle (Groovy DSL)"><div class="code-block" data-lang="gradle" data-title="Gradle">implementation 'me.axolotldev.dbconnector:xxxDriver:x.y.z@jar'</div></div><div class="tabs__content" data-gtm="tab" id="k4zqaq_41" data-title="Gradle Kotlin DSL"><div class="code-block" data-lang="kotlin" data-title="Kotlin">implementation(&quot;me.axolotldev.dbconnector:xxxDriver:x.y.z@jar&quot;)</div></div></div><ol class="list _decimal" id="k4zqaq_13" type="1" start="4"><li class="list__item" id="k4zqaq_45"><p id="k4zqaq_46">Create a Database Connection</p></li></ol><div class="tabs" id="k4zqaq_14" data-anchors="[k4zqaq_47,k4zqaq_48]"><div class="tabs__content" data-gtm="tab" id="k4zqaq_47" data-title="Java"><div class="code-block" data-lang="java" data-title="Java">
        import me.axolotldev.dbconnector.core.connect.ConnectBuilder;
        import me.axolotldev.dbconnector.abstracts.database.DatabaseInfo;
        import me.axolotldev.dbconnector.driver.xxxDriverData;
        import me.axolotldev.dbconnector.abstracts.database.Connector;

        import java.util.HashMap;
        import java.util.Map;
        import java.util.Properties;

        public class DatabaseConnection {
            public static void main(String[] args) {

                // Set URI options (e.g., SSL, timezone, etc.)
                final Map&lt;String, String&gt; options = new HashMap&lt;&gt;();
                options.put(&quot;ssl&quot;, &quot;true&quot;);
                // Add other parameters as needed

                // Create the database connection info
                final DatabaseInfo dbInfo = new DatabaseInfo(
                        &quot;127.0.0.1&quot;,     // URI
                        3306,            // Port
                        &quot;root&quot;,          // Username
                        &quot;password&quot;,      // Password (will be securely handled)
                        &quot;my_database&quot;,   // Database name
                        options          // Connection options
                );

                // Set internal behavior properties (optional)
                final Properties meta = new Properties();
                meta.put(&quot;autoReconnect&quot;, &quot;true&quot;);
                // Add more custom settings if needed

                // Create the database connection
                final Connector connector = new ConnectBuilder(
                        dbInfo,
                        xxxDriverData.INSTANCE,
                        meta
                ).build();

                // Now you can use the connector for operations
            }
        }

</div></div><div class="tabs__content" data-gtm="tab" id="k4zqaq_48" data-title="Kotlin"><div class="code-block" data-lang="kotlin" data-title="Kotlin">
        import me.axolotldev.dbconnector.core.connect.ConnectBuilder
        import me.axolotldev.dbconnector.abstracts.database.DatabaseInfo
        import me.axolotldev.dbconnector.driver.xxxDriverData
        import me.axolotldev.dbconnector.abstracts.database.Connector

        fun main() {
        // Create the database connection info and internal properties in one step
        val connector = ConnectBuilder(
        DatabaseInfo(
        &quot;127.0.0.1&quot;,     // URI
        3306,            // Port
        &quot;root&quot;,          // Username
        &quot;password&quot;,      // Password (will be securely handled)
        &quot;my_database&quot;,   // Database name
        mapOf(&quot;ssl&quot; to &quot;true&quot;) // Connection options
        ),
        xxxDriverData.INSTANCE,
        Properties().apply { put(&quot;autoReconnect&quot;, &quot;true&quot;) }  // Internal behavior properties
        ).build()

            // Now you can use the connector for operations
        }

</div></div></div><aside class="prompt" data-type="tip" data-title="" id="k4zqaq_15"><p id="k4zqaq_51">Options that can be set in the <code class="code" id="k4zqaq_52">meta</code> field can be found <a href="metadata.html" id="k4zqaq_53" data-tooltip="These metadata options can be used to control the behavior of DBConnector, allowing you to adjust logic based on your needs.">here</a></p></aside><ol class="list _decimal" id="k4zqaq_16" type="1" start="5"><li class="list__item" id="k4zqaq_54"><p id="k4zqaq_55">Connection Complete!</p></li></ol><p id="k4zqaq_17"><span class="control" id="k4zqaq_56">Now you can use the connector to execute queries, transactions, and encapsulate logic, etc.!</span></p><div class="last-modified">01 6月 2025</div><div data-feedback-placeholder="true"></div><div class="navigation-links _bottom"><a href="version.html" class="navigation-links__prev">Connector Information</a><a href="metadata.html" class="navigation-links__next">Available Metadata</a></div></article><div id="disqus_thread"></div></div></section></main></div><script src="https://resources.jetbrains.com/writerside/apidoc/6.22.0-b776/app.js"></script></body></html>