Skip to content

Commit 2dc3995

Browse files
sathishksathishk
committed
DDD
1 parent 69b90b9 commit 2dc3995

File tree

10 files changed

+173
-5
lines changed

10 files changed

+173
-5
lines changed

‎content/docs/getting-started/_index.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: "Getting Started"
3+
description: ""
4+
summary: ""
5+
date: 2023-09-07T16:06:50+02:00
6+
lastmod: 2023-09-07T16:06:50+02:00
7+
draft: false
8+
menu:
9+
docs:
10+
parent: ""
11+
identifier: "guides-4e0d0e0f89f7decc11eaad4ae9193018"
12+
weight: 2
13+
toc: true
14+
seo:
15+
title: "" # custom title (optional)
16+
description: "" # custom description (recommended)
17+
canonical: "" # custom canonical URL (optional)
18+
noindex: false # false (default) or true
19+
---

‎content/docs/guides/connection.md renamed to ‎content/docs/getting-started/connection.md

File renamed without changes.

‎content/docs/guides/instalation.md renamed to ‎content/docs/getting-started/instalation.md

File renamed without changes.

‎content/docs/guides/_index.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Getting Started"
2+
title: "API Guide"
33
description: ""
44
summary: ""
55
date: 2023-09-07T16:06:50+02:00
@@ -9,11 +9,13 @@ menu:
99
docs:
1010
parent: ""
1111
identifier: "guides-4e0d0e0f89f7decc11eaad4ae9193018"
12-
weight: 2
12+
weight: 3
1313
toc: true
1414
seo:
1515
title: "" # custom title (optional)
1616
description: "" # custom description (recommended)
1717
canonical: "" # custom canonical URL (optional)
1818
noindex: false # false (default) or true
1919
---
20+
21+
API Guide

‎content/docs/guides/manager.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: "Manager"
3+
description: "Guides lead a user through a specific task they want to accomplish, often with a sequence of steps."
4+
summary: ""
5+
date: 2023-09-07T16:04:48+02:00
6+
lastmod: 2023-09-07T16:04:48+02:00
7+
draft: false
8+
menu:
9+
docs:
10+
parent: ""
11+
identifier: "example-6a1a6be4373e933280d78ea53de6158e"
12+
weight: 1
13+
toc: true
14+
seo:
15+
title: "" # custom title (optional)
16+
description: "" # custom description (recommended)
17+
canonical: "" # custom canonical URL (optional)
18+
noindex: false # false (default) or true
19+
---
20+
21+
Lets connect to our database. First we need to add respective JDBC driver. for eg if we need to connect to postgres we need to add
22+
23+
```xml
24+
<dependency>
25+
<groupId>org.postgresql</groupId>
26+
<artifactId>postgresql</artifactId>
27+
<version>${postgresql.version}</version>
28+
</dependency>
29+
```
30+
31+
Next, We need configure SQLComponents to connect to our database instance. we should create file named `sql-components.yml` with below details
32+
33+
```yml
34+
# Connection Details
35+
name: Sample
36+
url: "jdbc:postgresql://localhost:5432/sampledb"
37+
userName: "user"
38+
password: "password"
39+
schemaName: "sampledb"
40+
41+
# Mapping Logic
42+
rootPackage: "com.example"
43+
```

‎content/docs/guides/model.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
title: "Model"
3+
description: "Guides lead a user through a specific task they want to accomplish, often with a sequence of steps."
4+
summary: ""
5+
date: 2023-09-07T16:04:48+02:00
6+
lastmod: 2023-09-07T16:04:48+02:00
7+
draft: false
8+
menu:
9+
docs:
10+
parent: ""
11+
identifier: "example-6a1a6be4373e933280d78ea53de6158e"
12+
weight: 2
13+
toc: true
14+
seo:
15+
title: "" # custom title (optional)
16+
description: "" # custom description (recommended)
17+
canonical: "" # custom canonical URL (optional)
18+
noindex: false # false (default) or true
19+
---
20+
21+
SQLComponents can be added as a build plugin. Also we need to add JDBC driver. for example if we need to work with postgres database we should add
22+
23+
```xml
24+
<build>
25+
<plugins>
26+
---
27+
<plugin>
28+
<groupId>org.sqlcomponents</groupId>
29+
<artifactId>maven-plugin</artifactId>
30+
<version>1.0-SNAPSHOT</version>
31+
<executions>
32+
<execution>
33+
<phase>generate-sources</phase>
34+
<goals>
35+
<goal>generated-sources</goal>
36+
</goals>
37+
</execution>
38+
</executions>
39+
<dependencies>
40+
<dependency>
41+
<groupId>org.postgresql</groupId>
42+
<artifactId>postgresql</artifactId>
43+
<version>${postgresql.version}</version>
44+
</dependency>
45+
46+
</dependencies>
47+
</plugin>
48+
---
49+
</plugins>
50+
</build>
51+
52+
```

‎content/docs/guides/store.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
title: "Store"
3+
description: "Guides lead a user through a specific task they want to accomplish, often with a sequence of steps."
4+
summary: ""
5+
date: 2023-09-07T16:04:48+02:00
6+
lastmod: 2023-09-07T16:04:48+02:00
7+
draft: false
8+
menu:
9+
docs:
10+
parent: ""
11+
identifier: "example-6a1a6be4373e933280d78ea53de6158e"
12+
weight: 3
13+
toc: true
14+
seo:
15+
title: "" # custom title (optional)
16+
description: "" # custom description (recommended)
17+
canonical: "" # custom canonical URL (optional)
18+
noindex: false # false (default) or true
19+
---
20+
21+
SQLComponents can be added as a build plugin. Also we need to add JDBC driver. for example if we need to work with postgres database we should add
22+
23+
```xml
24+
<build>
25+
<plugins>
26+
---
27+
<plugin>
28+
<groupId>org.sqlcomponents</groupId>
29+
<artifactId>maven-plugin</artifactId>
30+
<version>1.0-SNAPSHOT</version>
31+
<executions>
32+
<execution>
33+
<phase>generate-sources</phase>
34+
<goals>
35+
<goal>generated-sources</goal>
36+
</goals>
37+
</execution>
38+
</executions>
39+
<dependencies>
40+
<dependency>
41+
<groupId>org.postgresql</groupId>
42+
<artifactId>postgresql</artifactId>
43+
<version>${postgresql.version}</version>
44+
</dependency>
45+
46+
</dependencies>
47+
</plugin>
48+
---
49+
</plugins>
50+
</build>
51+
52+
```

‎content/docs/reference/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ menu:
99
docs:
1010
parent: ""
1111
identifier: "reference-22e9ba8aefa7ef9891199cf8db3a08cd"
12-
weight: 3
12+
weight: 4
1313
toc: true
1414
sidebar:
1515
collapsed: true

‎content/docs/roadmap/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ menu:
99
docs:
1010
parent: ""
1111
identifier: "reference-22e9ba8aefa7ef9891199cf8db3a08cd"
12-
weight: 4
12+
weight: 5
1313
toc: true
1414
sidebar:
1515
collapsed: true

‎layouts/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<p class="lead">{{ .Params.lead | safeHTML }}</p>
99
<a class="btn btn-secondary btn-cta rounded-pill btn-lg my-3" href="/docs/{{ if site.Params.doks.docsVersioning }}{{ site.Params.doks.docsVersion }}/{{ end }}why/" role="button">Why SQL Components?</a>
1010

11-
<a class="btn btn-primary btn-cta rounded-pill btn-lg my-3" href="/docs/{{ if site.Params.doks.docsVersioning }}{{ site.Params.doks.docsVersion }}/{{ end }}guides/" role="button">Getting Started</a>
11+
<a class="btn btn-primary btn-cta rounded-pill btn-lg my-3" href="/docs/{{ if site.Params.doks.docsVersioning }}{{ site.Params.doks.docsVersion }}/{{ end }}getting-started/" role="button">Getting Started</a>
1212

1313
{{ .Content }}
1414
</div>

0 commit comments

Comments
 (0)