| --- |
| { |
| "title": "Table Row Count Action", |
| "language": "en" |
| } |
| --- |
| |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, |
| software distributed under the License is distributed on an |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| KIND, either express or implied. See the License for the |
| specific language governing permissions and limitations |
| under the License. |
| --> |
| |
| # Table Row Count Action |
| |
| ## Request |
| |
| `GET /api/<db>/<table>/_count` |
| |
| ## Description |
| |
| Used to obtain statistics about the number of rows in a specified table. This interface is currently used in Spark-Doris-Connector. Spark obtains Doris table statistics. |
| |
| ## Path parameters |
| |
| * `<db>` |
| |
| Specify database |
| |
| * `<table>` |
| |
| Specify table |
| |
| ## Query parameters |
| |
| None |
| |
| ## Request body |
| |
| None |
| |
| ## Response |
| |
| ``` |
| { |
| "msg": "success", |
| "code": 0, |
| "data": { |
| "size": 1, |
| "status": 200 |
| }, |
| "count": 0 |
| } |
| ``` |
| |
| The `data.size` field indicates the number of rows in the specified table. |
| |
| ## Examples |
| |
| 1. Get the number of rows in the specified table. |
| |
| ``` |
| GET /api/db1/tbl1/_count |
| |
| Response: |
| { |
| "msg": "success", |
| "code": 0, |
| "data": { |
| "size": 1, |
| "status": 200 |
| }, |
| "count": 0 |
| } |
| ``` |