update docstring for Table.apply
Project: http://git-wip-us.apache.org/repos/asf/cassandra/repo Commit: http://git-wip-us.apache.org/repos/asf/cassandra/commit/39aae3d8 Tree: http://git-wip-us.apache.org/repos/asf/cassandra/tree/39aae3d8 Diff: http://git-wip-us.apache.org/repos/asf/cassandra/diff/39aae3d8 Branch: refs/heads/trunk Commit: 39aae3d8309e8cc4ba46feb24711f65796dbd88e Parents: 625e613 Author: Jonathan Ellis <jbel...@apache.org> Authored: Wed Jun 6 09:31:12 2012 -0500 Committer: Jonathan Ellis <jbel...@apache.org> Committed: Wed Jun 6 09:31:12 2012 -0500 ---------------------------------------------------------------------- src/java/org/apache/cassandra/db/Table.java | 12 ++++++++---- 1 files changed, 8 insertions(+), 4 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cassandra/blob/39aae3d8/src/java/org/apache/cassandra/db/Table.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/cassandra/db/Table.java b/src/java/org/apache/cassandra/db/Table.java index 901ba34..1308a08 100644 --- a/src/java/org/apache/cassandra/db/Table.java +++ b/src/java/org/apache/cassandra/db/Table.java @@ -372,10 +372,14 @@ public class Table } /** - * This method adds the row to the Commit Log associated with this table. - * Once this happens the data associated with the individual column families - * is also written to the column family store's memtable. - */ + * This method appends a row to the global CommitLog, then updates memtables and indexes. + * + * @param mutation the row to write. Must not be modified after calling apply, since commitlog append + * may happen concurrently, depending on the CL Executor type. + * @param writeCommitLog false to disable commitlog append entirely + * @param updateIndexes false to disable index updates (used by CollationController "defragmenting") + * @throws IOException + */ public void apply(RowMutation mutation, boolean writeCommitLog, boolean updateIndexes) throws IOException { if (logger.isDebugEnabled())