Apache/hbase
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

HBASE-16742 Add chapter for devs on how we do protobufs going forward; ADDENDUM -- add in Duo Zhang remark

Browse Source
This commit is contained in:
stack 2016-10-04 08:34:10 -07:00
parent 9e0c2562a9
commit b5d34cf6fc
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/main/asciidoc/_chapters/protobuf.adoc
View File

@ -74,12 +74,13 @@ practice needs to whither. We'll make plain why in the later
xref:shaded.protobuf[hbase-2.0.0] section.
[[cpeps]]
=== Coprocessor Endpoints
=== Coprocessor Endpoints (CPEPs)
xref:cp:[Coprocessor Endpoints] are custom API a developer can
add to HBase. Protobufs are used to describe the methods and arguments
that comprise the new Service.
Coprocessor Endpoints should make no use of HBase internals and
only avail of public APIs. This is not always possible but beware
only avail of public APIs; ideally a CPEP should depend on Interfaces
and data structures only. This is not always possible but beware
that doing so makes the Endpoint brittle, liable to breakage as HBase
internals evolve. HBase internal APIs annotated as private or evolving
do not have to respect semantic versioning rules or general java rules on