|
1 | | -"""Example table-in/table-out function implementations. |
| 1 | +"""Example table-in/table-out function implementations for testing VGI. |
2 | 2 |
|
3 | | -This module contains ready-to-use table functions that demonstrate common patterns. |
4 | | -Each function is documented to serve as a reference for implementing new functions. |
| 3 | +WARNING: EXAMPLE/TEST FUNCTIONS ONLY |
| 4 | +------------------------------------- |
| 5 | +These functions are reference implementations for testing and validating the VGI |
| 6 | +protocol. They are NOT intended for production use. The VGI protocol will have |
| 7 | +multiple implementations (Python, Go, JavaScript), and these examples serve as: |
| 8 | +
|
| 9 | +1. Protocol conformance tests - Verify implementations correctly handle the |
| 10 | + VGI streaming protocol (DATA, FINALIZE, HAVE_MORE_OUTPUT, etc.) |
| 11 | +2. Pattern demonstrations - Show how to implement common function patterns |
| 12 | +3. Cross-implementation test cases - Ensure consistent behavior across languages |
| 13 | +
|
| 14 | +Production considerations like memory limits, error recovery, and performance |
| 15 | +optimizations are intentionally omitted to keep the examples simple and focused |
| 16 | +on protocol correctness. |
5 | 17 |
|
6 | 18 | AVAILABLE FUNCTIONS |
7 | 19 | ------------------- |
@@ -101,9 +113,10 @@ class BufferInputFunction(TableInOutGeneratorFunction): |
101 | 113 | buffered_batches: list[pa.RecordBatch] |
102 | 114 | Accumulates all input batches in memory (instance attribute). |
103 | 115 |
|
104 | | - Warning: |
105 | | - ------- |
106 | | - Memory usage grows with input size. Not suitable for very large datasets. |
| 116 | + Note: |
| 117 | + ---- |
| 118 | + This is a test/example function for protocol validation. Memory buffering is |
| 119 | + intentional to test the FINALIZE phase of the VGI protocol. |
107 | 120 |
|
108 | 121 | Example: |
109 | 122 | ------- |
|
0 commit comments