Skip to content

Commit 791f253

Browse files
author
Bulat Shakirzyanov
committed
update docs
1 parent df2a74d commit 791f253

File tree

11 files changed

+116
-71
lines changed

11 files changed

+116
-71
lines changed

README.md

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,23 +14,13 @@ This is a wrapper around [the DataStax C/C++ Driver for Apache Cassandra and Dat
1414
* IRC: #datastax-drivers on [irc.freenode.net](http://freenode.net>)
1515
* Twitter: Follow the latest news about DataStax Drivers - [@avalanche123](http://twitter.com/avalanche123), [@mfiguiere](http://twitter.com/mfiguiere), [@al3xandru](https://twitter.com/al3xandru)
1616

17-
## Status of v1.0.0.rc
17+
## Status of v1.0.0
1818

19-
This is the first release candidate of the DataStax PHP Driver. This means that it
20-
is mostly feature complete but not entirely stable. Below, you'll find a list
21-
of functionality that is already supported as well as what's planned for the
22-
upcoming releases.
19+
This is the first stable release of the DataStax PHP Driver.
2320

24-
## What's new in v1.0.0.rc:
21+
## What's new in v1.0.0:
2522

26-
* Ability to [configure connection pooling](http://datastax.github.io/php-driver/features/#tweaking-driver-s-throughput).
27-
* Ability to [configure latency aware load balancing](http://datastax.github.io/php-driver/api/class/Cassandra/Cluster/Builder/#with-latency-aware-routing).
28-
* Ability to [set native protocol version](http://datastax.github.io/php-driver/features/#setting-protocol-version)
29-
* Support for configuring [TCP Nodelay](http://datastax.github.io/php-driver/features/#disabling-tcp-nodelay) and [TCP Keepalive](http://datastax.github.io/php-driver/features/#enabling-tcp-keepalive).
30-
31-
## Planned
32-
33-
* Expose [Schema Metadata](http://datastax.github.io/cpp-driver/api/CassSession/#cass-session-get-schema).
23+
* [Schema Metadata API](http://datastax.github.io/php-driver/features/#schema-metadata).
3424

3525
## Feedback Requested
3626

ext/doc/Cassandra/Collection.php

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -65,18 +65,16 @@ public function remove($index) {}
6565
/**
6666
* Retrieves the value at a given index.
6767
*
68-
* @param int $index Index
69-
*
70-
* @return mixed|null Value
68+
* @param int $index Index
69+
* @return mixed Value or null
7170
*/
7271
public function get($index) {}
7372

7473
/**
7574
* Finds index of a value in this collection.
7675
*
77-
* @param mixed $value Value
78-
*
79-
* @return int|null Index
76+
* @param mixed $value Value
77+
* @return int Index or null
8078
*/
8179
public function find($value) {}
8280

ext/doc/Cassandra/Column.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ interface Column
2525
{
2626
/**
2727
* Returns the name of the column.
28-
* @return string|null Name of the column or null
28+
* @return string Name of the column or null
2929
*/
3030
function name();
3131

@@ -55,13 +55,13 @@ function isFrozen();
5555

5656
/**
5757
* Returns name of the index if defined.
58-
* @return string|null Name of the index if defined
58+
* @return string Name of the index if defined or null
5959
*/
6060
function indexName();
6161

6262
/**
6363
* Returns index options if present.
64-
* @return string|null Index options if present
64+
* @return string Index options if present or null
6565
*/
6666
function indexOptions();
6767
}

ext/doc/Cassandra/DefaultColumn.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ final class DefaultColumn implements Column
2626
/**
2727
* {@inheritDoc}
2828
*
29-
* @return string|null Name of the column or null
29+
* @return string Name of the column or null
3030
*/
3131
public function name() {}
3232

@@ -61,14 +61,14 @@ public function isFrozen() {}
6161
/**
6262
* {@inheritDoc}
6363
*
64-
* @return string|null Name of the index if defined
64+
* @return string Name of the index if defined or null
6565
*/
6666
public function indexName() {}
6767

6868
/**
6969
* {@inheritDoc}
70-
*
71-
* @return string|null Index options if present
70+
*
71+
* @return string Index options if present or null
7272
*/
7373
public function indexOptions() {}
7474
}

ext/doc/Cassandra/DefaultKeyspace.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ public function hasDurableWrites() {}
5454
/**
5555
* {@inheritDoc}
5656
*
57-
* @param string $name Table name
58-
* @return Cassandra\Table|null Table instance or null
57+
* @param string $name Table name
58+
* @return Cassandra\Table Table instance or null
5959
*/
6060
public function table($name) {}
6161

ext/doc/Cassandra/DefaultSchema.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@ final class DefaultSchema implements Schema
2626
/**
2727
* {@inheritDoc}
2828
*
29-
* @param string $name Name of the keyspace to get
30-
* @return Cassandra\Keyspace|null Keyspace instance or null
29+
* @param string $name Name of the keyspace to get
30+
* @return Cassandra\Keyspace Keyspace instance or null
3131
*/
3232
public function keyspace($name) {}
3333

3434
/**
3535
* {@inheritDoc}
36-
*
36+
*
3737
* @return array An array of `Cassandra\Keyspace` instances.
3838
*/
3939
public function keyspaces() {}

ext/doc/Cassandra/DefaultTable.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ public function name() {}
3333
/**
3434
* {@inheritDoc}
3535
*
36-
* @return string|null Table description
36+
* @return string Table description or null
3737
*/
3838
public function comment() {}
3939

@@ -123,25 +123,25 @@ public function compressionParameters() {}
123123

124124
/**
125125
* {@inheritDoc}
126-
* @return boolean|null Value of `populate_io_cache_on_flush`
126+
* @return boolean Value of `populate_io_cache_on_flush` or null
127127
*/
128128
public function populateIOCacheOnFlush();
129129

130130
/**
131131
* {@inheritDoc}
132-
* @return boolean|null Value of `replicate_on_write`
132+
* @return boolean Value of `replicate_on_write` or null
133133
*/
134134
public function replicateOnWrite();
135135

136136
/**
137137
* {@inheritDoc}
138-
* @return int|null Value of `max_index_interval`
138+
* @return int Value of `max_index_interval` or null
139139
*/
140140
public function maxIndexInterval();
141141

142142
/**
143143
* {@inheritDoc}
144-
* @return int|null Value of `min_index_interval`
144+
* @return int Value of `min_index_interval` or null
145145
*/
146146
public function minIndexInterval();
147147

ext/doc/Cassandra/Map.php

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -153,9 +153,8 @@ public function offsetSet($key, $value) {}
153153
*
154154
* @throws Exception\InvalidArgumentException when the type of key is wrong
155155
*
156-
* @param mixed $key Key to use.
157-
*
158-
* @return mixed|null Value or `null`
156+
* @param mixed $key Key to use.
157+
* @return mixed Value or `null`
159158
*/
160159
public function offsetGet($key) {}
161160

ext/doc/Cassandra/Schema.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ interface Schema
2525
{
2626
/**
2727
* Returns a Keyspace instance by name.
28-
* @param string $name Name of the keyspace to get
29-
* @return Cassandra\Keyspace|null Keyspace instance or null
28+
* @param string $name Name of the keyspace to get
29+
* @return Cassandra\Keyspace Keyspace instance or null
3030
*/
3131
function keyspace($name);
3232

ext/doc/Cassandra/Table.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ function name();
3131

3232
/**
3333
* Description of the table, if any
34-
* @return string|null Table description
34+
* @return string Table description or null
3535
*/
3636
function comment();
3737

@@ -109,25 +109,25 @@ function compressionParameters();
109109

110110
/**
111111
* Returns whether or not the `populate_io_cache_on_flush` is true
112-
* @return boolean|null Value of `populate_io_cache_on_flush`
112+
* @return boolean Value of `populate_io_cache_on_flush` or null
113113
*/
114114
function populateIOCacheOnFlush();
115115

116116
/**
117117
* Returns whether or not the `replicate_on_write` is true
118-
* @return boolean|null Value of `replicate_on_write`
118+
* @return boolean Value of `replicate_on_write` or null
119119
*/
120120
function replicateOnWrite();
121121

122122
/**
123123
* Returns the value of `max_index_interval`
124-
* @return int|null Value of `max_index_interval`
124+
* @return int Value of `max_index_interval` or null
125125
*/
126126
function maxIndexInterval();
127127

128128
/**
129129
* Returns the value of `min_index_interval`
130-
* @return int|null Value of `min_index_interval`
130+
* @return int Value of `min_index_interval` or null
131131
*/
132132
function minIndexInterval();
133133

0 commit comments

Comments
 (0)