Github user jolynch commented on a diff in the pull request:
https://github.com/apache/cassandra/pull/277#discussion_r223780623
--- Diff: doc/source/operating/blacklisting_partitions.rst ---
@@ -0,0 +1,63 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+.. or more contributor license agreements. See the NOTICE file
+.. distributed with this work for additional information
+.. regarding copyright ownership. The ASF licenses this file
+.. to you under the Apache License, Version 2.0 (the
+.. "License"); you may not use this file except in compliance
+.. with the License. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+
+.. highlight:: none
+
+
+Blacklisting Partitions (CASSANDRA-12106)
+-----------------------------------------
+
+This feature allows partition keys to be blacklisted i.e. Cassandra would
not process following operations on those
--- End diff --
I think this can be a little clearer and spend more time on "why"
documentation as opposed to "how" (and don't link the ticket in the title). How
about something like:
```markdown
Partition Blacklist
-----------------------
Sometimes there are specific partitions that are "hot" and cause
instability in a Cassandra cluster. This can happen because of a bad data model
that is focusing many update operations on a single partitions, which causes a
partition to grow large over time and in turn it becomes very expensive to read.
Cassandra supports blacklisting such problematic partitions so that when
clients issue point reads (`SELECT` statements with the partition key
specified), instead of impacting Cassandra the query will be immediately
rejected with an `InvalidQueryException`
```
Might want to also explain what the error will look like for SEO (the text
in the error).
---
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
