Project

General

Profile

Wiki » History » Version 34

Tomek Dziemidowicz, 2019-07-18 09:03 PM

1 2 Tomek Dziemidowicz
h1. SQLite-sync documentation
2
3
*Owner* : AMPLIFIER sp. z o.o.
4
*Contact* : support (at) ampliapps.com
5
*website* : https://ampliapps.com
6
7 3 Tomek Dziemidowicz
{{>toc}}
8
9 9 Tomek Dziemidowicz
Welcome to the AMPLI-SYNC documentation!
10
We have language bindings in JavaScript, .NET C#, Java and Objective-C! 
11 1 Tomek Dziemidowicz
12 9 Tomek Dziemidowicz
h2. AMPLI-SYNC concept
13
14
h3. Solution diagram
15
16 8 Tomek Dziemidowicz
!{width:700px}SQLite-sync-structure.png!
17 1 Tomek Dziemidowicz
18 13 Tomek Dziemidowicz
* Devices communicate with server using HTTP/HTTPS protocol. 
19
* Proxy Load Balancer. If necessary, proxy can redirect request to another instance of SQLite-core.
20
* Authorization provider will generate token based on response from authorization provider.
21 9 Tomek Dziemidowicz
22
h3. Proxy Balancer flowchart
23
24
!{width:400px}SQLite-sync-proxy-balancer.png!
25
26
h3. Authorization Provider flowchart
27
28
!{width:350px}SQLite-sync-authentication-process.png!
29
30 2 Tomek Dziemidowicz
h2. REST API (server API)
31
32 10 Tomek Dziemidowicz
h3. Protocol version
33
34
This document describes integration with the REST API 3.x protocol.
35
36
h3. Service description
37
38
There are two stages to processing a request:
39
40 12 Tomek Dziemidowicz
* Device places an request.
41
* SQLite-sync server confirms the request has been processed successfully and sends confirmation with eventual conflict list that need to be resolved.
42 10 Tomek Dziemidowicz
43 11 Tomek Dziemidowicz
h3. Synchronization flowchart
44
45
!{width:200px;}Device-synchronization-diagram.png!
46 10 Tomek Dziemidowicz
47 23 Tomek Dziemidowicz
h3. Request URL format
48 22 Tomek Dziemidowicz
49
Sample REST API call:
50
<pre>
51
https://example.com/API3/__method___
52
</pre>
53
Explanation:
54
*https://example.com/* - adres of REST API service 
55
*API3* - version of synchronization
56
*__method___* - method/action
57
58 24 Tomek Dziemidowicz
h3. API methods
59
60 28 Tomek Dziemidowicz
h4. *API3* - control method
61
62
*Method* : GET
63
*Path* : “/API3”
64
*Produces* : TEXT_HTML
65
*Description* : control method. Returns “API[v3] SQLite-Sync.COM is working correctly!” if web service is correctly configured.
66
67 29 Tomek Dziemidowicz
h4. *InitializeSubscriber* - Reinitialize subscriber
68 28 Tomek Dziemidowicz
69
*Method* : GET
70
*Path* : “/InitializeSubscriber/{subscriberUUID}”
71
*Produces* : TEXT_PLAIN
72
*Description* : Reinitialize subscriber, create empty schema on device, prepare master database for new subscriber.
73
74
Implementation examples: 
75 29 Tomek Dziemidowicz
* [[InitializeSubscriber Objective-C]]
76
* [[InitializeSubscriber .NET C#]]
77
* [[InitializeSubscriber JAVA]]
78
* [[InitializeSubscriber JavaScript]]
79 28 Tomek Dziemidowicz
80 25 Tomek Dziemidowicz
h4. *Sync* - gets changes for table
81 26 Tomek Dziemidowicz
82 1 Tomek Dziemidowicz
*Method* : GET
83 26 Tomek Dziemidowicz
*Path* : /Sync/{subscriberUUID}/{tableName}
84 1 Tomek Dziemidowicz
*Produces* : TEXT_PLAIN
85 26 Tomek Dziemidowicz
*Description* : Get changed data. 
86
Params:
87 1 Tomek Dziemidowicz
*subscriberUUID* - identifier of subscriber. By default device unique ID is used. But we can place there any value (also #user.UUID)
88 26 Tomek Dziemidowicz
*tableName* - name of table from database (without schema)
89 1 Tomek Dziemidowicz
Response:
90 26 Tomek Dziemidowicz
<pre><code class="xml">
91
<?xml version="1.0" encoding="utf-8"?>
92
<records>
93
  <r a="1">
94
    <c>2</c>
95
    <c>Document</c>
96
    <c>75541</c>
97
    <c>2014-02-13 00:00:00</c>
98
    <c>665.000</c>
99
    <c>2c93d64e-cc72-11e3-87e0-f82fa8e587f9</c>
100
  </r>
101
  <r a="2">
102
    <c>4</c>
103
    <c>Document 4</c>
104
    <c>4879</c>
105
    <c>2014-04-23 13:44:48</c>
106
    <c>4875.000</c>
107
    <c>2c93d765-cc72-11e3-87e0-f82fa8e587f9</c>
108
  </r>
109
</records>
110
</code></pre>
111
<records> - section contains records 
112
<r a=”1”> - here starts record. 
113
</r> - here record ends
114
Attribute “a” (action type)
115
1 - new record
116
2 - update for record
117 1 Tomek Dziemidowicz
118 27 Tomek Dziemidowicz
Implementation examples: 
119 26 Tomek Dziemidowicz
* [[Objective-C]]
120
* [[.NET C#]]
121
* [[JAVA]]
122
* [[JavaScript]]
123 25 Tomek Dziemidowicz
124 34 Tomek Dziemidowicz
h4. *CommitSync* - control method
125 33 Tomek Dziemidowicz
126
*Method* : GET
127
*Path* : “/CommitSync/{syncId}”
128
*Produces* : TEXT_PLAIN
129
*Description* : If device recieved all changes without error this method should be call to tell server that there was no errors during receiving package. Params: *syncId* - id of data package
130
131
Implementation examples: 
132
* [[CommitSync Objective-C]]
133
* [[CommitSync .NET C#]]
134
* [[CommitSync JAVA]]
135
* [[CommitSync JavaScript]]
136
137 2 Tomek Dziemidowicz
h2. Conflict Resolution
138
139
h2. Update procedure
140
141
h2. Data filtering
142
143 1 Tomek Dziemidowicz
h2. Installation
144 9 Tomek Dziemidowicz
145 18 Tomek Dziemidowicz
h3. Server Prerequisites
146
147
To make ampli-sync server work you need:
148
* Apache Tomcat 8.
149
* Java
150
* Linux/Windows environment. 
151
152 9 Tomek Dziemidowicz
h3. Manual
153
154 14 Tomek Dziemidowicz
Steps needed to install AMPLI-SYNC manually on Ubuntu.
155
156 15 Tomek Dziemidowicz
# Install Tomcat on Ubuntu:
157 14 Tomek Dziemidowicz
https://www.digitalocean.com/community/tutorials/how-to-install-apache-tomcat-8-on-ubuntu-16-04
158
# Create new user
159
<pre>
160
sudo adduser amplisync
161
</pre>
162
System will ask you for password for newly created user.
163
# Add user to group ‘tomcat’
164
<pre>
165
sudo usermod -a -G tomcat amplisync
166
</pre>
167
# Chang in web.xml path variable to 
168
<pre>
169
\home/sqlitesync/demo
170
</pre>
171
# Install new application in Tomcat. Start with switching to amplisync user.
172
<pre>
173
su amplisync
174
</pre>
175
# Create new folder /home/sqlitesync/demo
176 16 Tomek Dziemidowicz
# Upload new service amplisync-demo to Tomcat. You can do that using Tomcat application manager, or you can put WAR file in Tomcat webapps folder. Name of your WAR file is app name in Tomcat environment. Remember to not place spaces and special chars in name of your WAR file.
177 17 Tomek Dziemidowicz
# Restart Tomcat:
178 14 Tomek Dziemidowicz
<pre>
179
service tomcat restart
180
</pre>
181
Now you can access your installation using link:
182
<pre>
183
http://your_ip:8080/amplisync-app-name/API3
184
</pre>
185
# Setup permissions:
186
<pre>
187
chown -R sqlitesync:tomcat /home/amplisync/demo/
188
</pre>
189
190 9 Tomek Dziemidowicz
h3. Docker
191 2 Tomek Dziemidowicz
192 20 Tomek Dziemidowicz
h3. Configuring AMPLI-SYNC service
193 19 Tomek Dziemidowicz
194
First you need to adjust website configuration file (web.xml), then you need to change main configuration file (sync.properties).
195
*Service configuration (web.xml)*
196
Go to your_webapps_folder/SqliteSync/WEB-INF/web.xml and open for edit. Navigate to section:
197
<pre><code class="xml">
198
<env-entry>
199
<env-entry-name>working-dir</env-entry-name>
200
<env-entry-type>java.lang.String</env-entry-type>
201
<env-entry-value>/your/working/dir/sqlite-sync/</env-entry-value>
202
</env-entry>
203
</code></pre>
204
change env-entry-value key and point to working dir where SQLite-sync.com server will store log files, temporary files and configuration. Create manually a subfolder named config. Create a text file sync.properties in folder config. The path should look like this:
205
<pre>
206
\working_dir\config\sync.properties
207
</pre>
208
*IMPORTANT* Restart service after changing web.xml. Make sure that Tomcat has read/write access to working dir.
209
Sample configurations for MySQL server
210
<pre>
211
DB_ENGINE = mysql
212
DBURL = jdbc:mysql://server:3306/dbname?rewriteBatchedStatements=true
213
DBUSER = user
214
DBPASS = pass
215
DBDRIVER = com.mysql.cj.jdbc.Driver
216
DATE_FORMAT = yyyy-MM-dd HH:mm:ss
217
HISTORY_DAYS = 7
218
LOG_LEVEL = 4
219
</pre>
220
If you faced a timezone error after configuration in `sync.properties` add at the end of connection string:
221
<pre>
222
&useUnicode=true&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=UTC
223
</pre>
224
*Keys explanation*
225 21 Tomek Dziemidowicz
*DB_ENGINE* - type of database engine. Available options:
226
* mysql
227
* mssql
228
* postgresql
229
* oracle
230
231 19 Tomek Dziemidowicz
*LOG_LEVEL* - defain details level for log
232
> 4: TRACE, DEBUG, INFO, WARN; (default)
233
> 3: DEBUG, INFO, WARN; 
234
> 2: INFO,WARN; 
235
> 1: WARN; 
236
> 0 - disable logs
237
*DATE_FORMAT* - set format of date 
238
default format: yyyy-MM-dd HH:mm:ss 
239
*HISTORY_DAYS* - How long files with sync data will be kept
240
default value: 7
241
When you use MySQL database DO NOT remove from the end of the connection string:
242
<pre>
243
?rewriteBatchedStatements=true
244 20 Tomek Dziemidowicz
</pre>
245 19 Tomek Dziemidowicz
246 2 Tomek Dziemidowicz
h2. Supported databases
247
248 30 Tomek Dziemidowicz
AMPLI-SYNC supports those databases:
249
250
* MySQL
251
* Microsoft SQL Server (2005 and newer)
252
* Oracle
253
* PostgreSQL
254
255 31 Tomek Dziemidowicz
h3. Supported columns data types
256
257
SQLite-sync.com uses own conversion table to match column data types when schema from master database is converted to sqlite database.
258
* blob
259
* longblob
260
* varbinary
261
* binary
262
* image
263
* mediumblob
264
* varbinarymax
265
* byte[]
266
* longtext
267
* varchar
268
* nvarchar
269
* char
270
* varcharmax
271
* enum
272
* mediumtext
273
* text
274
* string
275
* geography
276
* geometry
277
* hierarchyid
278
* nchar
279
* ntext
280
* nvarcharmax
281
* userdefineddatatype
282
* userdefinedtabletype
283
* userdefinedtype
284
* variant
285
* xml
286
* tinytext
287
* set
288
* time
289
* timestamp
290
* year
291
* datetime
292
* uniqueidentifier
293
* datetime2
294
* date
295
* mediumint
296
* bit
297
* tinyint
298
* smallint
299
* bigint
300
* int
301
* boolean
302
* byte
303
* long
304
* int64
305
* serial
306
* int32
307
* smalldatetime
308
* double
309
* float
310
* numeric
311
* decimal
312
* real
313
* money
314
315 32 Tomek Dziemidowicz
h3. Primary Key requirements
316
317
Single and mupltiple columns are supported as primary key.
318
When column is AUTO_INCREMENT/SERIAL, identity pool management is handled by AMPLI_SYNC. It means when you insert a new record onto the device, the PK will be automatically changed for the first value available for device. 
319 30 Tomek Dziemidowicz
320 2 Tomek Dziemidowicz
h2. Samples