Browse files

Updated POD documentation

  • Loading branch information...
1 parent b711169 commit fc27c868dd91123baf62f13c55cdd99a8e89a9ce @fmgoncalves committed Jul 18, 2011
Showing with 26 additions and 24 deletions.
  1. +19 −11 README
  2. +7 −13 lib/Cassandra/Simple.pm
View
30 README
@@ -46,7 +46,7 @@ SYNOPSYS
$opt is a *HASH* and can have the following keys:
columns, column_start, column_finish, column_count, column_reversed,
- consistency_level_read
+ super_column, consistency_level_read
Returns an HASH of the form "{ column => value, column => value }"
@@ -65,7 +65,8 @@ SYNOPSYS
$opt is a *HASH* and can have the following keys:
- columns, column_start, column_finish, consistency_level_read
+ columns, column_start, column_finish, super_column,
+ consistency_level_read
Returns the count as an int
@@ -84,7 +85,7 @@ SYNOPSYS
$opt is a *HASH* and can have the following keys:
start, finish, columns, column_start, column_finish, column_reversed,
- column_count, row_count, consistency_level_read
+ column_count, row_count, super_column, consistency_level_read
Returns an *HASH* of the form "{ key => { column => value, column =>
value }, key => { column => value, column => value } }"
@@ -110,8 +111,17 @@ SYNOPSYS
insert
Usage: "insert($column_family, $key, $columns[, opt])"
- The *expression_list* is an *ARRAYREF* of the form "[ [ column => value
- ] ]"
+ The $columns is an *ARRAYREF* of the form "[ [ column => value ] ]"
+
+ $opt is an *HASH* and can have the following keys:
+
+ timestamp, ttl, consistency_level_write
+
+ insert_super
+ Usage: "insert($column_family, $key, $columns[, opt])"
+
+ The $columns is an *HASH* of the form "{ super_column => { column =>
+ value, column => value } }"
$opt is an *HASH* and can have the following keys:
@@ -159,10 +169,12 @@ BUGS
<https://github.com/fmgoncalves/p5-cassandra-simple>.
TODO
- SuperColumn Support
-
Unit Tests
+ Sort of done in the examples folder
+ <https://github.com/fmgoncalves/p5-cassandra-simple/tree/master/exampl
+ es>
+
Methods
The following are Thrift methods left unimplemented.
@@ -200,10 +212,6 @@ TODO
string describe_version()
- system_add_column_family
-
- string system_add_column_family(CFDef cf_def)
-
system_drop_column_family
string system_drop_column_family(ColumnFamily column_family)
View
20 lib/Cassandra/Simple.pm
@@ -1,7 +1,5 @@
package Cassandra::Simple;
-#TODO Synopsys
-
=pod
=encoding utf8
@@ -567,7 +565,6 @@ sub insert {
Cassandra::ColumnParent->new( { column_family => $column_family } );
my $level = $self->_consistency_level_write($opt);
- #TODO: ttl in column
my @mutations = map {
new Cassandra::Mutation(
{
@@ -621,7 +618,6 @@ sub insert_super {
Cassandra::ColumnParent->new( { column_family => $column_family } );
my $level = $self->_consistency_level_write($opt);
- #TODO: ttl in column
my @mutations = map {
my $arg = $_;
new Cassandra::Mutation(
@@ -684,7 +680,6 @@ sub batch_insert {
Cassandra::ColumnParent->new( { column_family => $column_family } );
my $level = $self->_consistency_level_write($opt);
- #TODO: ttl in column
my %mutation_map = map {
$_ => {
$column_family => [
@@ -801,8 +796,6 @@ sub list_keyspace_cfs {
return map { $_->{name} => $_->{column_type} } @{ $result->{cf_defs} };
}
-#TODO: Doc
-
=head2 create_column_family
Usage C<< create_column_family($keyspace, $column_family[, $is_super][, $comment]) >>
@@ -841,10 +834,15 @@ Bugs should be reported on github at L<https://github.com/fmgoncalves/p5-cassand
=head1 TODO
-B<SuperColumn Support>
-
B<Unit Tests>
+=over 2
+
+Sort of done in the examples folder
+L<https://github.com/fmgoncalves/p5-cassandra-simple/tree/master/examples>
+
+=back
+
B<Methods>
The following are Thrift methods left unimplemented.
@@ -883,10 +881,6 @@ describe_version
string describe_version()
-system_add_column_family
-
-string system_add_column_family(CFDef cf_def)
-
system_drop_column_family
string system_drop_column_family(ColumnFamily column_family)

0 comments on commit fc27c86

Please sign in to comment.