Updated QuickStart (markdown)

2026-11-04 00:30:15 +08:00 · 2013-02-05 06:59:23 -08:00
parent 31a32b8231
commit db22d8bc9f
1 changed files with 121 additions and 0 deletions
--- a/QuickStart.md
+++ b/QuickStart.md
@@ -0,0 +1,121 @@
+<p>1.  下载canal</p>
+<p>下载部署包</p>
+<pre name="code" class="java">wget http://canal4mysql.googlecode.com/files/canal.deployer-1.0.0.tar.gz</pre>
+<p>or </p>
+<p>自己编译 </p>
+<pre name="code" class="java">git clone git@github.com:otter-projects/canal.git
+cd canal; 
+mvn clean install -Dmaven.test.skip -Denv=release</pre>
+<p>    编译完成后，会在根目录下产生target/canal.deployer-$version.tar.gz </p>
+<p> </p>
+<p>2.  解压缩</p>
+<pre name="code" class="java">mkdir /tmp/canal
+tar zxvf canal.deployer-1.0.0.tar.gz  -C /tmp/canal</pre>
+<p>   </p>
+<p>   解压完成后，进入/tmp/canal目录，可以看到如下结构：</p>
+<p> </p>
+<pre name="code" class="java">drwxr-xr-x 2 jianghang jianghang  136 2013-02-05 21:51 bin
+drwxr-xr-x 4 jianghang jianghang  160 2013-02-05 21:51 conf
+drwxr-xr-x 2 jianghang jianghang 1.3K 2013-02-05 21:51 lib
+drwxr-xr-x 2 jianghang jianghang   48 2013-02-05 21:29 logs</pre>
+<p> </p>
+<p>3.  配置修改</p>
+<p> </p>
+<p>公用参数：   </p>
+<pre name="code" class="shell">vi conf/canal.properties</pre>
+<pre name="code" class="java">#################################################
+#########               common argument         ############# 
+#################################################
+canal.id= 1
+canal.address=
+canal.port= 11111
+canal.zkServers=
+# flush data to zk
+canal.zookeeper.flush.period = 1000
+## memory store RingBuffer size, should be Math.pow(2,n)
+canal.instance.memory.buffer.size = 32768
+
+## detecing config
+canal.instance.detecting.enable = false
+canal.instance.detecting.sql = insert into retl.xdual values(1,now()) on duplicate key update x=now()
+canal.instance.detecting.interval.time = 3 
+canal.instance.detecting.retry.threshold = 3 
+canal.instance.detecting.heartbeatHaEnable = false
+
+# support maximum transaction size, more than the size of the transaction will be cut into multiple transactions delivery
+canal.instance.transactionn.size =  1024
+
+# network config
+canal.instance.network.receiveBufferSize = 16384
+canal.instance.network.sendBufferSize = 16384
+canal.instance.network.soTimeout = 30
+
+#################################################
+#########               destinations            ############# 
+#################################################
+canal.destinations= example
+
+canal.instance.global.mode = spring 
+canal.instance.global.lazy = true  ##修改为false，代表立马启动
+#canal.instance.global.manager.address = 127.0.0.1:1099
+canal.instance.global.spring.xml = classpath:spring/memory-instance.xml
+#canal.instance.global.spring.xml = classpath:spring/default-instance.xml</pre>
+<p> </p>
+<p>应用参数：</p>
+<pre name="code" class="shell">vi conf/example/instance.properties</pre>
+<pre name="code" class="instance.properties">#################################################
+## mysql serverId
+canal.instance.mysql.slaveId = 1234
+
+# position info
+canal.instance.master.address = 127.0.0.1:3306 #改成自己的数据库地址
+canal.instance.master.journal.name = 
+canal.instance.master.position = 
+canal.instance.master.timestamp = 
+
+#canal.instance.standby.address = 
+#canal.instance.standby.journal.name =
+#canal.instance.standby.position = 
+#canal.instance.standby.timestamp = 
+
+# username/password
+canal.instance.dbUsername = retl  #改成自己的数据库信息
+canal.instance.dbPassword = retl  #改成自己的数据库信息
+canal.instance.defaultDatabaseName =   #改成自己的数据库信息
+canal.instance.connectionCharsetNumber = 33  #改成自己的数据库信息
+canal.instance.connectionCharset = UTF-8  #改成自己的数据库信息
+
+# table regex
+canal.instance.filter.regex = .*\\..*
+
+#################################################
+</pre>
+<p> </p>
+<p> </p>
+<p> 说明：</p>
+<ul>
+<li>canal.instance.connectionCharset 代表数据库的编码方式对应到java中的编码类型，比如UTF-8，GBK , ISO-8859-1</li>
+<li>canal.instance.connectionCharsetNumber 代表数据库的编码方式对应mysql中的唯一id，详细的映射关系可查看：com.mysql.jdbc.CharsetMapping.INDEX_TO_CHARSET<br>针对常见的编码：<br>utf-8  &lt;=&gt;  33<br>gb2312 &lt;=&gt; 24<br>gbk &lt;=&gt; 28</li>
+</ul>
+<p>4.   准备启动</p>
+<p> </p>
+<pre name="code" class="java">sh bin/startup.sh</pre>
+<p> </p>
+<p>5.  查看日志</p>
+<pre name="code" class="java">vi logs/canal/canal.log</pre>
+<pre name="code" class="java">2013-02-05 22:45:27.967 [main] INFO  com.alibaba.otter.canal.deployer.CanalLauncher - ## start the canal server.
+2013-02-05 22:45:28.113 [main] INFO  com.alibaba.otter.canal.deployer.CanalController - ## start the canal server[10.1.29.120:11111]
+2013-02-05 22:45:28.210 [main] INFO  com.alibaba.otter.canal.deployer.CanalLauncher - ## the canal server is running now ......</pre>
+<p>     </p>
+<p>    具体instance的日志：</p>
+<pre name="code" class="java">vi logs/example/example.log</pre>
+<pre name="code" class="java">2013-02-05 22:50:45.636 [main] INFO  c.a.o.c.i.spring.support.PropertyPlaceholderConfigurer - Loading properties file from class path resource [canal.properties]
+2013-02-05 22:50:45.641 [main] INFO  c.a.o.c.i.spring.support.PropertyPlaceholderConfigurer - Loading properties file from class path resource [example/instance.properties]
+2013-02-05 22:50:45.803 [main] INFO  c.a.otter.canal.instance.spring.CanalInstanceWithSpring - start CannalInstance for 1-example 
+2013-02-05 22:50:45.810 [main] INFO  c.a.otter.canal.instance.spring.CanalInstanceWithSpring - start successful....</pre>
+<p> </p>
+<p>6.  关闭</p>
+<pre name="code" class="java">sh bin/stop.sh</pre>
+<p> </p>
+<p>it's over. </p>
+</div>