This is an automated email from the ASF dual-hosted git repository.
vjasani pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/phoenix-adapters.git
The following commit(s) were added to refs/heads/main by this push:
new 9cf9aaf API doc updates
9cf9aaf is described below
commit 9cf9aaf09977643ea80a4aa2511590f096a7fcfb
Author: Viraj Jasani <[email protected]>
AuthorDate: Fri Apr 10 15:49:22 2026 -0700
API doc updates
---
DDB_API_REFERENCE.md | 14 +++++++-------
README.md | 12 ++++++------
2 files changed, 13 insertions(+), 13 deletions(-)
diff --git a/DDB_API_REFERENCE.md b/DDB_API_REFERENCE.md
index f25e082..1916fb1 100644
--- a/DDB_API_REFERENCE.md
+++ b/DDB_API_REFERENCE.md
@@ -114,7 +114,7 @@ Client applications using **any AWS SDK** (Java, Python,
Node.js, Go, etc.) only
└───────────────────────────────┘
```
-### Key Design Decisions
+### High Level Design Components
1. **Single POST Endpoint**: All operations hit `POST /`. The operation is
determined by the `X-Amz-Target` header (e.g., `DynamoDB_20120810.CreateTable`).
2. **BSON Column Storage**: Each DynamoDB item is stored as a single BSON
document in a Phoenix column named `COL`. Primary key and Secondary key columns
are stored separately for indexing.
@@ -371,7 +371,7 @@ All list/query/scan operations support pagination:
| GetRecords response size | 1 MB | GetRecords |
| Query result limit (max per page) | 100 items OR 1 MB, whichever comes first
| Query |
| Scan result limit (max per page) | 100 items OR 1 MB, whichever comes first
| Scan |
-| GetRecords limit (max per page) | 50 records | GetRecords |
+| GetRecords limit (max per page) | 50 records OR 1 MB, whichever comes first
| GetRecords |
| ListTables default limit | 100 tables | ListTables |
| ListStreams default limit | 100 streams | ListStreams |
| DescribeStream shard limit | 100 shards | DescribeStream |
@@ -478,7 +478,7 @@ CREATE TABLE IF NOT EXISTS "SCHEMA"."MyTable" (
"id" VARCHAR NOT NULL,
"COL" BSON,
CONSTRAINT pk PRIMARY KEY ("id")
-) IS_STRICT_TTL=false, UPDATE_CACHE_FREQUENCY=1800000, ...
+) IS_STRICT_TTL=false, UPDATE_CACHE_FREQUENCY=60000, ...
```
For tables with a sort key:
@@ -1700,11 +1700,11 @@ bin/phoenix-adapters rest start -p <port> -z <zk-quorum>
| `phoenix.ddb.rest.dns.interface` | `default` | DNS interface for hostname
resolution |
| `phoenix.ddb.rest.dns.nameserver` | `default` | DNS nameserver |
-### Phoenix Table Configuration (phoenix-table-options.properties)
+### Phoenix Table Default Configuration (phoenix-table-options.properties)
```properties
IS_STRICT_TTL=false
-UPDATE_CACHE_FREQUENCY=1800000
+UPDATE_CACHE_FREQUENCY=60000
phoenix.max.lookback.age.seconds=97200
hbase.hregion.majorcompaction=172800000
org.apache.hadoop.hbase.index.lazy.post_batch.write=true
@@ -1809,9 +1809,9 @@ Each API operation tracks:
---
-## Quick Reference:
+## API Reference:
-| # | Category | Operation | X-Amz-Target Suffix |
+| # | Category | Operation | X-Amz-Target |
|---|---|---|---|
| 1 | DDL | CreateTable | `DynamoDB_20120810.CreateTable` |
| 2 | DDL | DeleteTable | `DynamoDB_20120810.DeleteTable` |
diff --git a/README.md b/README.md
index fdaa97b..be3c3dd 100644
--- a/README.md
+++ b/README.md
@@ -42,7 +42,7 @@ endpoint.
- DeleteItem
- **Change Stream**:
- ListStreams
- - DescribeStreams
+ - DescribeStream
- GetShardIterator
- GetRecords
@@ -120,13 +120,13 @@ Logging can be configured in `conf/log4j.properties`. The
default configuration
To start the REST server as a daemon:
```bash
-bin/phoenix-adapters start rest
+bin/phoenix-adapters rest start
```
To start in foreground mode (for debugging):
```bash
-bin/phoenix-adapters rest
+bin/phoenix-adapters rest foreground_start
```
### Checking Server Status
@@ -134,7 +134,7 @@ bin/phoenix-adapters rest
To check if the server is running:
```bash
-bin/phoenix-adapters status rest
+bin/phoenix-adapters rest status
```
### Stopping the Server
@@ -142,7 +142,7 @@ bin/phoenix-adapters status rest
To stop the server:
```bash
-bin/phoenix-adapters stop rest
+bin/phoenix-adapters rest stop
```
### Restarting the Server
@@ -150,7 +150,7 @@ bin/phoenix-adapters stop rest
To restart the server:
```bash
-bin/phoenix-adapters restart rest
+bin/phoenix-adapters rest restart
```
## Logs
