noSQL/couchReplicator.php at master · lbain/noSQL · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
<?PHP


/**
* Special class to handle replication stuff, as the API is still evolving
*
*
*
*
*/
class couchReplicator {
	/**
	* @var reference to our CouchDB client
	*/
	private $client = null;

	/**
	* @var replication options
	*/
	private $opts = array();

	/**
	*constructor
	*
	* @param couchClient $client the couchClient instance
	*/
	function __construct ( couchClient $client ) {
		$this->client = $client;
	}

	/**
	* chainable method : tell couchdb to create target database if it doesn't exist
	*
	* @return couchReplicator $this
	*/
	public function create_target () {
		$this->opts['create_target'] = true;
		return $this;
	}

	/**
	* chainable method : setup a continuous replication stream
	*
	* @return couchReplicator $this
	*/
	public function continuous () {
		$this->opts['continuous'] = true;
		return $this;
	}

	/**
	* chainable method : cancel a continuous replication stream
	*
	* TODO: check if that works (apparently that doesn't)
	*
	* @return couchReplicator $this
	*/
	public function cancel () {
		$this->opts['cancel'] = true;
		return $this;
	}

	/**
	* chainable method : restrict replication to given document ids
	*
	* @param array $ids list of document ids to replicate
	* @return couchReplicator $this
	*/
	public function doc_ids ( array $ids ) {
		$this->opts['doc_ids'] = $ids;
		return $this;
	}

	/**
	* chainable method : set replication filter
	*
	* filter design doc should belong to the source database
	*
	* @param string $name replication filter name ( ex mydesign/myfilter )
	* @return couchReplicator $this
	*/
	public function filter ( $name ) {
		$this->opts['filter'] = $name;
		return $this;
	}

	/**
	* chainable method : set query params (for example for a filtered replication)
	*
	* @param array|object $ids list of document ids to replicate
	* @return couchReplicator $this
	*/
	public function query_params ( $params ) {
		$this->opts['query_params'] = $params;
		return $this;
	}


	/**
	* replicate from local TO specified url (push replication)
	*
	* @param string $url url of the remote couchDB server
	* @return object couchDB server response to replication request
	*/
	public function to ( $url ) {
		$this->opts['source'] = $this->client->getDatabaseName();
		$this->opts['target'] = $url;
		return $this->_launch();
	}

	/**
	* replicate to local FROM specified url (push replication)
	*
	* @param string $url url of the remote couchDB server
	* @return object couchDB server response to replication request
	*/
	public function from ( $url ) {
		$this->opts['target'] = $this->client->getDatabaseName();
		$this->opts['source'] = $url;
		return $this->_launch();
	}


	private function _launch() {
		$opts = $this->opts;
		$this->opts = array();
// 		echo "posting to /_replicate";
		$raw = $this->client->query(
			"POST",
			'/_replicate',
			array(),
			$opts
		);
// 		print_r($raw);
		$resp = couch::parseRawResponse($raw);
// 		print_r($resp);
		if ( $resp['status_code'] == 200 ) {
			return $resp['body'];
		}
		// continuous setup returns 202 Accepted
		if ( array_key_exists('continuous',$opts) && $opts['continuous'] == true && $resp['status_code'] == 202 ) {
			return $resp['body'];
		}
		throw new couchException($raw);
	}
}