You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
feat: default include_declared to true in ListTables (#332)
## Summary
- Default `include_declared` to `true` in `ListTablesRequest` schema and
REST query parameter for backwards compatibility
- Add `include_declared` query parameter to both `ListTables` and
`ListAllTables` REST endpoints
---------
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: docs/src/client/operations/models/ListTablesRequest.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@
12
12
|**id**|**List<String>**||[optional]|
13
13
|**pageToken**|**String**| An opaque token that allows pagination for list operations (e.g. ListNamespaces). For an initial request of a list operation, if the implementation cannot return all items in one response, or if there are more items than the page limit specified in the request, the implementation must return a page token in the response, indicating there are more results available. After the initial request, the value of the page token from each response must be used as the page token value for the next request. Caller must interpret either `null`, missing value or empty string value of the page token from the implementation's response as the end of the listing results. |[optional]|
14
14
|**limit**|**Integer**| An inclusive upper bound of the number of results that a caller will receive. |[optional]|
15
-
|**includeDeclared**|**Boolean**| When true, includes tables that have been declared in the namespace but not yet created on storage, in addition to tables that have been created. When false or not set, only tables with storage components are returned. |[optional]|
15
+
|**includeDeclared**|**Boolean**| When true (default), includes tables that have been declared in the namespace but not yet created on storage, in addition to tables that have been created. When false, only tables with storage components are returned. |[optional]|
Copy file name to clipboardExpand all lines: java/lance-namespace-apache-client/docs/ListTablesRequest.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@
12
12
|**id**|**List<String>**||[optional]|
13
13
|**pageToken**|**String**| An opaque token that allows pagination for list operations (e.g. ListNamespaces). For an initial request of a list operation, if the implementation cannot return all items in one response, or if there are more items than the page limit specified in the request, the implementation must return a page token in the response, indicating there are more results available. After the initial request, the value of the page token from each response must be used as the page token value for the next request. Caller must interpret either `null`, missing value or empty string value of the page token from the implementation's response as the end of the listing results. |[optional]|
14
14
|**limit**|**Integer**| An inclusive upper bound of the number of results that a caller will receive. |[optional]|
15
-
|**includeDeclared**|**Boolean**| When true, includes tables that have been declared in the namespace but not yet created on storage, in addition to tables that have been created. When false or not set, only tables with storage components are returned. |[optional]|
15
+
|**includeDeclared**|**Boolean**| When true (default), includes tables that have been declared in the namespace but not yet created on storage, in addition to tables that have been created. When false, only tables with storage components are returned. |[optional]|
List all child table names of the parent namespace `id`. REST NAMESPACE ONLY REST namespace uses GET to perform this operation without a request body. It passes in the `ListTablesRequest` information in the following way: - `id`: pass through path parameter of the same name - `page_token`: pass through query parameter of the same name - `limit`: pass through query parameter of the same name
2618
+
List all child table names of the parent namespace `id`. REST NAMESPACE ONLY REST namespace uses GET to perform this operation without a request body. It passes in the `ListTablesRequest` information in the following way: - `id`: pass through path parameter of the same name - `page_token`: pass through query parameter of the same name - `limit`: pass through query parameter of the same name - `include_declared`: pass through query parameter of the same name
2619
2619
2620
2620
### Example
2621
2621
@@ -2652,8 +2652,9 @@ public class Example {
2652
2652
String delimiter ="delimiter_example"; // String | An optional delimiter of the `string identifier`, following the Lance Namespace spec. When not specified, the `$` delimiter must be used.
2653
2653
String pageToken ="pageToken_example"; // String | Pagination token from a previous request
2654
2654
Integer limit =56; // Integer | Maximum number of items to return
2655
+
Boolean includeDeclared =true; // Boolean | When true (default), includes tables that have been declared in the namespace but not yet created on storage, in addition to tables that have been created. When false, only tables with storage components are returned.
2655
2656
try {
2656
-
ListTablesResponse result = apiInstance.listTables(id, delimiter, pageToken, limit);
2657
+
ListTablesResponse result = apiInstance.listTables(id, delimiter, pageToken, limit, includeDeclared);
2657
2658
System.out.println(result);
2658
2659
} catch (ApiException e) {
2659
2660
System.err.println("Exception when calling MetadataApi#listTables");
@@ -2675,6 +2676,7 @@ public class Example {
2675
2676
|**delimiter**|**String**| An optional delimiter of the `string identifier`, following the Lance Namespace spec. When not specified, the `$` delimiter must be used. |[optional]|
2676
2677
|**pageToken**|**String**| Pagination token from a previous request |[optional]|
2677
2678
|**limit**|**Integer**| Maximum number of items to return |[optional]|
2679
+
|**includeDeclared**|**Boolean**| When true (default), includes tables that have been declared in the namespace but not yet created on storage, in addition to tables that have been created. When false, only tables with storage components are returned. |[optional][default to true]|
List all child table names of the parent namespace `id`. REST NAMESPACE ONLY REST namespace uses GET to perform this operation without a request body. It passes in the `ListTablesRequest` information in the following way: - `id`: pass through path parameter of the same name - `page_token`: pass through query parameter of the same name - `limit`: pass through query parameter of the same name
392
+
List all child table names of the parent namespace `id`. REST NAMESPACE ONLY REST namespace uses GET to perform this operation without a request body. It passes in the `ListTablesRequest` information in the following way: - `id`: pass through path parameter of the same name - `page_token`: pass through query parameter of the same name - `limit`: pass through query parameter of the same name - `include_declared`: pass through query parameter of the same name
393
393
394
394
### Example
395
395
@@ -426,8 +426,9 @@ public class Example {
426
426
String delimiter ="delimiter_example"; // String | An optional delimiter of the `string identifier`, following the Lance Namespace spec. When not specified, the `$` delimiter must be used.
427
427
String pageToken ="pageToken_example"; // String | Pagination token from a previous request
428
428
Integer limit =56; // Integer | Maximum number of items to return
429
+
Boolean includeDeclared =true; // Boolean | When true (default), includes tables that have been declared in the namespace but not yet created on storage, in addition to tables that have been created. When false, only tables with storage components are returned.
429
430
try {
430
-
ListTablesResponse result = apiInstance.listTables(id, delimiter, pageToken, limit);
431
+
ListTablesResponse result = apiInstance.listTables(id, delimiter, pageToken, limit, includeDeclared);
431
432
System.out.println(result);
432
433
} catch (ApiException e) {
433
434
System.err.println("Exception when calling NamespaceApi#listTables");
@@ -449,6 +450,7 @@ public class Example {
449
450
|**delimiter**|**String**| An optional delimiter of the `string identifier`, following the Lance Namespace spec. When not specified, the `$` delimiter must be used. |[optional]|
450
451
|**pageToken**|**String**| Pagination token from a previous request |[optional]|
451
452
|**limit**|**Integer**| Maximum number of items to return |[optional]|
453
+
|**includeDeclared**|**Boolean**| When true (default), includes tables that have been declared in the namespace but not yet created on storage, in addition to tables that have been created. When false, only tables with storage components are returned. |[optional][default to true]|
0 commit comments