Project

General

Profile

Wiki » History » Version 35

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 35 Tomek Dziemidowicz
h4. *Send* - control method
138
139
*Method* : GET
140
*Path* : “/API3”
141
*Produces* : TEXT_HTML
142
*Description* : control method. Returns “API[v3] SQLite-Sync.COM is working correctly!” if web service is correctly configured.
143
144
145 2 Tomek Dziemidowicz
h2. Conflict Resolution
146
147
h2. Update procedure
148
149
h2. Data filtering
150
151 1 Tomek Dziemidowicz
h2. Installation
152 9 Tomek Dziemidowicz
153 18 Tomek Dziemidowicz
h3. Server Prerequisites
154
155
To make ampli-sync server work you need:
156
* Apache Tomcat 8.
157
* Java
158
* Linux/Windows environment. 
159
160 9 Tomek Dziemidowicz
h3. Manual
161
162 14 Tomek Dziemidowicz
Steps needed to install AMPLI-SYNC manually on Ubuntu.
163
164 15 Tomek Dziemidowicz
# Install Tomcat on Ubuntu:
165 14 Tomek Dziemidowicz
https://www.digitalocean.com/community/tutorials/how-to-install-apache-tomcat-8-on-ubuntu-16-04
166
# Create new user
167
<pre>
168
sudo adduser amplisync
169
</pre>
170
System will ask you for password for newly created user.
171
# Add user to group ‘tomcat’
172
<pre>
173
sudo usermod -a -G tomcat amplisync
174
</pre>
175
# Chang in web.xml path variable to 
176
<pre>
177
\home/sqlitesync/demo
178
</pre>
179
# Install new application in Tomcat. Start with switching to amplisync user.
180
<pre>
181
su amplisync
182
</pre>
183
# Create new folder /home/sqlitesync/demo
184 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.
185 17 Tomek Dziemidowicz
# Restart Tomcat:
186 14 Tomek Dziemidowicz
<pre>
187
service tomcat restart
188
</pre>
189
Now you can access your installation using link:
190
<pre>
191
http://your_ip:8080/amplisync-app-name/API3
192
</pre>
193
# Setup permissions:
194
<pre>
195
chown -R sqlitesync:tomcat /home/amplisync/demo/
196
</pre>
197
198 9 Tomek Dziemidowicz
h3. Docker
199 2 Tomek Dziemidowicz
200 20 Tomek Dziemidowicz
h3. Configuring AMPLI-SYNC service
201 19 Tomek Dziemidowicz
202
First you need to adjust website configuration file (web.xml), then you need to change main configuration file (sync.properties).
203
*Service configuration (web.xml)*
204
Go to your_webapps_folder/SqliteSync/WEB-INF/web.xml and open for edit. Navigate to section:
205
<pre><code class="xml">
206
<env-entry>
207
<env-entry-name>working-dir</env-entry-name>
208
<env-entry-type>java.lang.String</env-entry-type>
209
<env-entry-value>/your/working/dir/sqlite-sync/</env-entry-value>
210
</env-entry>
211
</code></pre>
212
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:
213
<pre>
214
\working_dir\config\sync.properties
215
</pre>
216
*IMPORTANT* Restart service after changing web.xml. Make sure that Tomcat has read/write access to working dir.
217
Sample configurations for MySQL server
218
<pre>
219
DB_ENGINE = mysql
220
DBURL = jdbc:mysql://server:3306/dbname?rewriteBatchedStatements=true
221
DBUSER = user
222
DBPASS = pass
223
DBDRIVER = com.mysql.cj.jdbc.Driver
224
DATE_FORMAT = yyyy-MM-dd HH:mm:ss
225
HISTORY_DAYS = 7
226
LOG_LEVEL = 4
227
</pre>
228
If you faced a timezone error after configuration in `sync.properties` add at the end of connection string:
229
<pre>
230
&useUnicode=true&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=UTC
231
</pre>
232
*Keys explanation*
233 21 Tomek Dziemidowicz
*DB_ENGINE* - type of database engine. Available options:
234
* mysql
235
* mssql
236
* postgresql
237
* oracle
238
239 19 Tomek Dziemidowicz
*LOG_LEVEL* - defain details level for log
240
> 4: TRACE, DEBUG, INFO, WARN; (default)
241
> 3: DEBUG, INFO, WARN; 
242
> 2: INFO,WARN; 
243
> 1: WARN; 
244
> 0 - disable logs
245
*DATE_FORMAT* - set format of date 
246
default format: yyyy-MM-dd HH:mm:ss 
247
*HISTORY_DAYS* - How long files with sync data will be kept
248
default value: 7
249
When you use MySQL database DO NOT remove from the end of the connection string:
250
<pre>
251
?rewriteBatchedStatements=true
252 20 Tomek Dziemidowicz
</pre>
253 19 Tomek Dziemidowicz
254 2 Tomek Dziemidowicz
h2. Supported databases
255
256 30 Tomek Dziemidowicz
AMPLI-SYNC supports those databases:
257
258
* MySQL
259
* Microsoft SQL Server (2005 and newer)
260
* Oracle
261
* PostgreSQL
262
263 31 Tomek Dziemidowicz
h3. Supported columns data types
264
265
SQLite-sync.com uses own conversion table to match column data types when schema from master database is converted to sqlite database.
266
* blob
267
* longblob
268
* varbinary
269
* binary
270
* image
271
* mediumblob
272
* varbinarymax
273
* byte[]
274
* longtext
275
* varchar
276
* nvarchar
277
* char
278
* varcharmax
279
* enum
280
* mediumtext
281
* text
282
* string
283
* geography
284
* geometry
285
* hierarchyid
286
* nchar
287
* ntext
288
* nvarcharmax
289
* userdefineddatatype
290
* userdefinedtabletype
291
* userdefinedtype
292
* variant
293
* xml
294
* tinytext
295
* set
296
* time
297
* timestamp
298
* year
299
* datetime
300
* uniqueidentifier
301
* datetime2
302
* date
303
* mediumint
304
* bit
305
* tinyint
306
* smallint
307
* bigint
308
* int
309
* boolean
310
* byte
311
* long
312
* int64
313
* serial
314
* int32
315
* smalldatetime
316
* double
317
* float
318
* numeric
319
* decimal
320
* real
321
* money
322
323 32 Tomek Dziemidowicz
h3. Primary Key requirements
324
325
Single and mupltiple columns are supported as primary key.
326
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. 
327 30 Tomek Dziemidowicz
328 2 Tomek Dziemidowicz
h2. Samples