Obtención de detalles de una base de datos

Envío de una GET solicitud a https://$ACCOUNT.cloudant.com/$DATABASE devuelve detalles sobre la base de datos, como cuántos documentos contiene.

Consulte el ejemplo siguiente de utilización de HTTP para obtener detalles de una base de datos:

GET /$DATABASE HTTP/1.1

Consulte el ejemplo siguiente para obtener los detalles de la base de datos:

curl -H "Authorization: Bearer $API_BEARER_TOKEN" -X GET "$SERVICE_URL/products"

import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.DatabaseInformation;
import com.ibm.cloud.cloudant.v1.model.GetDatabaseInformationOptions;

Cloudant service = Cloudant.newInstance();

GetDatabaseInformationOptions databaseInfoOptions =
    new GetDatabaseInformationOptions.Builder()
        .db("products")
        .build();

DatabaseInformation response =
    service.getDatabaseInformation(databaseInfoOptions).execute()
        .getResult();

System.out.println(response);

const { CloudantV1 } = require('@ibm-cloud/cloudant');

const service = CloudantV1.newInstance({});

service.getDatabaseInformation({db: 'products'}).then(response => {
  console.log(response.result);
});

from ibmcloudant.cloudant_v1 import CloudantV1

service = CloudantV1.new_instance()

response = service.get_database_information(db='products').get_result()

print(response)

getDatabaseInformationOptions := service.NewGetDatabaseInformationOptions(
  "products",
)

databaseInformation, response, err := service.GetDatabaseInformation(getDatabaseInformationOptions)
if err != nil {
  panic(err)
}

b, _ := json.MarshalIndent(databaseInformation, "", "  ")
fmt.Println(string(b))

El ejemplo Go anterior requiere el siguiente bloque de importación:

import (
   "encoding/json"
   "fmt"
   "github.com/IBM/cloudant-go-sdk/cloudantv1"
)

Todos los ejemplos de Go requieren que se inicialice el objeto service. Para obtener más información, consulte los ejemplos de la Sección de autenticación de la documentación de la API.

Los elementos de la estructura que se devuelve se muestran en la tabla siguiente:

Detalles de base de datos
Campo	Descripción
`compact_running`	Se establece en true si la rutina de compactación de base de datos está funcionando en esta base de datos.
`db_name`	El nombre de la base de datos.
`disk_format_version`	La versión del formato físico que se utiliza para los datos almacenados en disco.
`disk_size`	Tamaño en bytes de los datos almacenados en el disco. Los índices de vistas no se incluyen en el cálculo.
`doc_count`	Recuento de los documentos de la base de datos especificada.
`doc_del_count`	Número de documentos suprimidos.
`instance_start_time`	Siempre 0.
`other`	Objeto JSON que contiene un campo `data_size`.
`purge_seq`	El número de operaciones de depuración (purge) en la base de datos.
`sizes`	Un objeto JSON, que contiene tamaños de `file`, `external` y `active`. `active` es el tamaño en bytes de datos que se almacenan internamente (excluyendo las revisiones antiguas). `external` es el tamaño en bytes de datos de usuario descomprimido. Este valor es el tamaño de los datos facturables. El campo `other/data_size` es un alias para el campo `external`. `file` es el tamaño en bytes de los datos que se almacenan en el disco. Los índices no se incluyen en el cálculo. El campo `disk_size` es un alias para el campo `file`. Este tamaño incluye los datos que están a la espera de compactación.
`update_seq`	Una serie opaca que describe el estado de la base de datos. No se base en esta serie para contar el número de actualizaciones.
`partitioned_indexes`	Un objeto JSON que solo aparece si la base de datos está particionada. `count` es el número de índices particionados. `indexes` lista el tipo de índices particionados y `limit` muestra el número máximo de índices particionados permitidos.

Consulte la siguiente respuesta (abreviada) de ejemplo que contiene detalles de una base de datos:

{
	"update_seq": "982...uUQ",
	"db_name": "db",
	"sizes": {
		"file": 46114703224,
		"external": 193164408719,
		"active": 34961621142
	},
	"purge_seq": 0,
	"other": {
		"data_size": 193164408719
	},
	"doc_del_count": 5564,
	"doc_count": 9818541,
	"disk_size": 46114703224,
	"disk_format_version": 6,
	"compact_running": true,
	"instance_start_time": "0",
	"partitioned_indexes": {
		"count": 7,
		"indexes": {
			"search": 1,
			"view": 6
		},
		"limit": 10
	}
}