Rate Per Micro-Batch Data Source

Author: jaceklaskowski

docs/datasources/rate-micro-batch/RatePerMicroBatchProvider.md

@@ -1,20 +1,20 @@
 # RatePerMicroBatchProvider
 
-`RatePerMicroBatchProvider` is a `SimpleTableProvider` ([Spark SQL]({{ book.spark_sql }}/connector/SimpleTableProvider)).
+`RatePerMicroBatchProvider` is a `SimpleTableProvider` ([Spark SQL]({{ book.spark_sql }}/connector/SimpleTableProvider)) registered under [rate-micro-batch](#shortName) alias.
 
 ## <span id="DataSourceRegister"><span id="shortName"> DataSourceRegister
 
 `RatePerMicroBatchProvider` is a `DataSourceRegister` ([Spark SQL]({{ book.spark_sql }}/DataSourceRegister)) that registers `rate-micro-batch` alias.
 
-## <span id="getTable"> Creating Table
+## Create Table { #getTable }
 
-```scala
-getTable(
-  options: CaseInsensitiveStringMap): Table
-```
+??? note "SimpleTableProvider"
 
-`getTable` creates a [RatePerMicroBatchTable](RatePerMicroBatchTable.md) with the [options](options.md) (given the `CaseInsensitiveStringMap`).
+    ```scala
+    getTable(
+      options: CaseInsensitiveStringMap): Table
+    ```
 
----
+    `getTable` is part of the `SimpleTableProvider` ([Spark SQL]({{ book.spark_sql }}/connector/SimpleTableProvider#getTable)) abstraction.
 
-`getTable` is part of the `SimpleTableProvider` ([Spark SQL]({{ book.spark_sql }}/connector/SimpleTableProvider#getTable)) abstraction.
+`getTable` creates a [RatePerMicroBatchTable](RatePerMicroBatchTable.md) with the [options](options.md) (given the `CaseInsensitiveStringMap`).

docs/datasources/rate-micro-batch/RatePerMicroBatchTable.md

@@ -15,28 +15,42 @@
 
 * `RatePerMicroBatchProvider` is requested for the [table](RatePerMicroBatchProvider.md#getTable)
 
-## <span id="schema"> schema
+## Table Capabilities { #capabilities }
 
-```scala
-schema(): StructType
-```
+??? note "Table"
+
+    ```scala
+    capabilities(): Set[TableCapability]
+    ```
+
+    `capabilities` is part of the `Table` ([Spark SQL]({{ book.spark_sql }}/connector/Table#capabilities)) abstraction.
+
+`capabilities` is exactly `MICRO_BATCH_READ` table capability.
+
+## Schema { #schema }
+
+??? note "Table"
+
+    ```scala
+    schema(): StructType
+    ```
+
+    `schema` is part of the `Table` ([Spark SQL]({{ book.spark_sql }}/connector/Table#schema)) abstraction.
 
 Name | Data Type
 -----|----------
-timestamp | TimestampType
-value | LongType
-
-`schema` is part of the `Table` ([Spark SQL]({{ book.spark_sql }}/connector/Table#schema)) abstraction.
+`timestamp` | `TimestampType`
+`value` | `LongType`
 
-## <span id="newScanBuilder"> Creating ScanBuilder
+## Create ScanBuilder { #newScanBuilder }
 
-```scala
-newScanBuilder(
-  options: CaseInsensitiveStringMap): ScanBuilder
-```
+??? note "SupportsRead"
 
-`newScanBuilder` is part of the `SupportsRead` ([Spark SQL]({{ book.spark_sql }}/connector/SupportsRead#newScanBuilder)) abstraction.
+    ```scala
+    newScanBuilder(
+      options: CaseInsensitiveStringMap): ScanBuilder
+    ```
 
----
+    `newScanBuilder` is part of the `SupportsRead` ([Spark SQL]({{ book.spark_sql }}/connector/SupportsRead#newScanBuilder)) abstraction.
 
 `newScanBuilder` creates a new `Scan` ([Spark SQL]({{ book.spark_sql }}/connector/Scan)) that creates a [RatePerMicroBatchStream](RatePerMicroBatchStream.md) when requested for a `MicroBatchStream` ([Spark SQL]({{ book.spark_sql }}/connector/Scan#toMicroBatchStream)).

docs/datasources/rate-micro-batch/index.md

@@ -1,3 +1,8 @@
+---
+hide:
+  - toc
+---
+
 # Rate Per Micro-Batch Data Source
 
 **Rate Per Micro-Batch Data Source** provides a consistent number of rows per microbatch.

docs/datasources/rate-micro-batch/options.md

@@ -1,17 +1,25 @@
 # Options
 
-## <span id="advanceMillisPerBatch"><span id="ADVANCE_MILLIS_PER_BATCH"> advanceMillisPerBatch
+## <span id="ADVANCE_MILLIS_PER_BATCH"> advanceMillisPerBatch { #advanceMillisPerBatch }
 
 default: `1000`
 
-## <span id="numPartitions"><span id="NUM_PARTITIONS"> numPartitions
+Must be non-negative
 
-default: `SparkSession.active.sparkContext.defaultParallelism`
+## <span id="NUM_PARTITIONS"> numPartitions { #numPartitions }
 
-## <span id="rowsPerBatch"><span id="ROWS_PER_BATCH"> rowsPerBatch
+default: `SparkContext.defaultParallelism`
+
+Must be non-zero and positive
+
+## <span id="ROWS_PER_BATCH"> rowsPerBatch { #rowsPerBatch }
 
 default: `0`
 
-## <span id="startTimestamp"><span id="START_TIMESTAMP"> startTimestamp
+Must be non-zero and positive
+
+## <span id="START_TIMESTAMP"> startTimestamp { #startTimestamp }
 
 default: `0`
+
+Must be non-negative