Skip to content

Commit f875dcf

Browse files
javasgljavasgl
committed
feat: add liquibase feature for studygolang.com
1 parent 137d406 commit f875dcf

16 files changed

+815
-4
lines changed

‎config/changelogs/1.0/studygolang.xml

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<databaseChangeLog
2+
xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
3+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4+
xmlns:ext="http://www.liquibase.org/xml/ns/dbchangelog-ext"
5+
xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.1.xsd
6+
http://www.liquibase.org/xml/ns/dbchangelog-ext http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-ext.xsd">
7+
8+
9+
<changeSet id="1" author="javasgl">
10+
<createTable tableName="test_liquibase">
11+
<column name="id" type="int">
12+
<constraints primaryKey="true" nullable="false"/>
13+
</column>
14+
<column name="name" type="varchar(50)">
15+
<constraints nullable="false"/>
16+
</column>
17+
<column name="active" type="boolean" defaultValueBoolean="true"/>
18+
</createTable>
19+
</changeSet>
20+
21+
</databaseChangeLog>

‎config/changelogs/README.md

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
### 说明:
2+
数据库变更采用`Liquibase`管理，建表、修改字段、添加索引等操作需要编写 xml 配置文件来实现，不再需要手动改动数据库。
3+
4+
Liquibase 文档: http://www.liquibase.org/documentation/index.html
5+
6+
`changelogs`文件夹下建议按照`1.0、1.2、1.3、2.0 ...`等存放每次需要改动的配置文件。
7+
8+
每个版本中的`xml`文件名需要和 `env.ini`中配置`dbname` 的一致，比如 `studygolang.xml`.
9+
10+
### 示例
11+
12+
`changelogs/1.0/studygolang.xml` 中新建了一个表 `test_liquibase`.
13+
```
14+
<changeSet id="1" author="javasgl">
15+
<createTable tableName="test_liquibase">
16+
<column name="id" type="int">
17+
<constraints primaryKey="true" nullable="false"/>
18+
</column>
19+
<column name="name" type="varchar(50)">
20+
<constraints nullable="false"/>
21+
</column>
22+
<column name="active" type="boolean" defaultValueBoolean="true"/>
23+
</createTable>
24+
</changeSet>
25+
```
26+
执行
27+
```
28+
./bin/migrator --changeVersion=1.0
29+
```
30+
即可在数据中新建一个表`test_liquibase`.
31+
32+
---
33+
34+
过了一段时间，需要给这个表添加一个字段`status`.编写`xml`配置文件存于`changelogs/1.1/studygolang.xml`,内容如下：
35+
```
36+
<changeSet id="1" author="javasgl">
37+
<comment>增加status字段</comment>
38+
<addColumn tableName="test_liquibase">
39+
<column name="status" type="tinyint unsigned" defaultValue="0" remarks="status">
40+
<constraints nullable="false" />
41+
</column>
42+
</addColumn>
43+
</changeSet>
44+
```
45+
执行:
46+
```
47+
./bin/migrator --changeVersion=1.1
48+
```
49+
即可为`test_liquibase`表加上`status`字段。
50+
51+
> Liquibase 更多功能请看其 [官方文档](http://www.liquibase.org/documentation/index.html)，功能很强大。

‎config/env.sample.ini

+6-1
Original file line numberDiff line numberDiff line change
@@ -121,4 +121,9 @@ repo = studygolang/GCTT
121121
token_secret = yX56JYeIEI
122122

123123
[include_files]
124-
;path = config/auto_crawl_conf.ini
124+
;path = config/auto_crawl_conf.ini
125+
126+
[migrator]
127+
liquibase_lib_dir = liquibase
128+
; 数据库变更配置文件
129+
change_log_dir = config/changelogs

‎install.bat

+1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ gofmt -w -s src
1919
go install server/studygolang
2020
go install server/indexer
2121
go install server/crawler
22+
go install server/migrator
2223

2324
set GOPATH=%OLDGOPATH%
2425

‎install.sh

+1
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ BUILD="`git symbolic-ref HEAD | cut -b 12-`-`git rev-parse HEAD`"
2424
go install -ldflags "-X global.Build="$BUILD server/studygolang
2525
go install server/indexer
2626
go install server/crawler
27+
go install server/migrator
2728

2829
export GOPATH="$OLDGOPATH"
2930
export GOBIN="$OLDGOBIN"

‎liquibase/LICENSE.txt

+202
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎liquibase/README.txt

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
This directory allows you both run Liquibase in a normal production setting to manage your database as well as develop
2+
and test Liquibase extensions.
3+
4+
ROOT DIRECTORY STRUCTURE:
5+
----------------------------------------
6+
7+
The root of this directory is designed to run Liquibase. There are shell and batch scripts (liquibase and liquibase.bat)
8+
which will run the Liquibase command line application.
9+
10+
The "lib" directory is automatically scanned by the liquibase scripts and all .jar files are added to the classpath.
11+
If you have JDBC drivers or Liquibase extensions that you want to be automatically included, add them to this directory.
12+
13+
The "lib-other" directory is not automatically scanned by the liquibase scripts. This directory can be used to store jar
14+
files that are referenced with manual --classpath references. Storing JDBC drivers in lib-other instead of lib allows
15+
you to control which versions of the driver are used by liquibase. Storing extensions in lib-other instead of lib allows
16+
you to control which extensions are used by liquibase.
17+
18+
The "sdk" directory is designed to allow you to develop and test Liquibase extensions as well as test Liquibase itself.
19+
See below for more information.
20+
21+
22+
SDK DIRECTORY STRUCTURE
23+
----------------------------------------
24+
25+
** For more information, see http://liquibase.org/documentation/sdk**
26+
27+
The "sdk" directory contains liquibase-sdk shell and batch scripts for running the Liquibase SDK application.
28+
The Liquibase-sdk application allows you to create and manage test databases in virtual machines, execute tests, and more.
29+
30+
The "javadoc" directory contains the Liquibase core library API documentation.
31+
32+
The "lib-sdk" directory is used to store jars used by liquibase-sdk but not standard liquibase usage. Anything added to
33+
this directory is automatically included in the liquibase-sdk classpath, but if you have any additional jars to
34+
include, add them to LIQUIBASE_HOME/lib or LIQUIBASE_HOME/lib-other instead of here.
35+
36+
The "vagrant" directory is where images created by the "liquibase-sdk vagrant" command are stored.
37+
See below for more information.
38+
39+
The "workspace" directory is a simple structure designed to allow testing of liquibase and liquibase extensions. For
40+
real usage, you should have your changelog files managed with your application code but the workspace directory has a
41+
starting example changelog as well as properties files for several databases that leverage the virtual machines managed
42+
through the "liqubiase-sdk vagrant" command.
43+
44+
VAGRANT USAGE
45+
----------------------------------------
46+
47+
You can easily create databases for testing Liquibase using the vagrant configurations the vagrant directory and with
48+
the "liquibase-sdk vagrant" command.
49+
50+
For commercial databases, the generated vagrant configurations expect the installers/zip/etc. files to be placed in
51+
LIQUIBASE_HOME/sdk/vagrant/install-files/PRODUCT. Where PRODUCT is "oracle", "mssql", "windows" etc. Running
52+
"liquibase-sdk vagrant init" should give you information on what files are expected in this directory.

‎liquibase/lib/mysql-connector-java-5.1.25-bin.jar

829 KB
Binary file not shown.

‎liquibase/lib/snakeyaml-1.17.jar

267 KB
Binary file not shown.

0 commit comments

Comments
 (0)