Obtener una colección
Al realizar una operación GET en un recurso de colección específico, se recuperan las propiedades de la colección.
Nota:
En estos artículos de referencia de API se muestra cómo crear recursos mediante la API del plano de datos de Azure Cosmos DB. Con la API del plano de datos, puede configurar opciones básicas, como la directiva de indexación, las claves de partición del mismo modo que puede usar los SDK de Cosmos DB. Si necesita compatibilidad completa con características para todos los recursos de Azure Cosmos DB, se recomienda usar el proveedor de recursos de Cosmos DB.
Solicitud
| Método | URI de solicitud | Descripción |
|---|---|---|
| GET | https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id} | {databaseaccount} es el nombre de la cuenta de Azure Cosmos DB creada en la suscripción. El valor {db-id} es el nombre o identificador generado por el usuario de la base de datos, no el identificador generado por el sistema (rid). El valor {coll-id} es el nombre de la colección. |
encabezados
Consulte Encabezados de solicitud REST comunes de Azure Cosmos DB para los encabezados que usan todas las solicitudes de Cosmos DB.
Cuerpo
Ninguno.
Response
Get Collection devuelve el cuerpo de la colección tal y como se conserva en Cosmos DB junto con encabezados de respuesta que informan de la cuota y el uso de la colección.
encabezados
Consulte Encabezados de respuesta REST comunes de Azure Cosmos DB para ver los encabezados devueltos por todas las respuestas de Cosmos DB.
Códigos de estado
La tabla siguiente muestra los códigos de estado comunes que devuelve esta operación. Para obtener una lista completa de los códigos de estado, consulte Códigos de estado HTTP.
| Código de estado HTTP | Descripción |
|---|---|
| 200 Ok | La operación se realizó correctamente. |
| 404 No encontrado | La colección ya no es un recurso, es decir, se eliminó la colección. |
Body
| Propiedad | Descripción |
|---|---|
| id | Es el nombre único que identifica la nueva colección. |
| _Librar | Es una propiedad generada por el sistema. El identificador de recurso (_rid) es un identificador único que también es jerárquico por la pila de recursos en el modelo de recursos. Se usa internamente para la colocación y la navegación del recurso de permiso. |
| _Ts | Es una propiedad generada por el sistema. Especifica la última marca de tiempo actualizada del recurso. El valor es una marca de tiempo. |
| _propio | Es una propiedad generada por el sistema. Es el URI direccionable único para el recurso. |
| _Etag | Es una propiedad generada por el sistema que representa la etag de recursos necesaria para el control de simultaneidad optimista. |
| _Doc | Es una propiedad generada por el sistema que especifica la ruta de acceso direccionable del recurso documents. |
| _sprocs | Es una propiedad generada por el sistema que especifica la ruta de acceso direccionable del recurso de procedimientos almacenados (sprocs). |
| _desencadenantes | Es una propiedad generada por el sistema que especifica la ruta de acceso direccionable del recurso triggers. |
| _Udfs | Es una propiedad generada por el sistema que especifica la ruta de acceso direccionable del recurso de funciones definidas por el usuario (udfs). |
| _Conflictos | Es una propiedad generada por el sistema que especifica la ruta de acceso direccionable del recurso de conflictos. Durante una operación en un recurso dentro de una colección, si se produce un conflicto, los usuarios pueden inspeccionar los recursos en conflicto realizando una operación GET en la ruta URI en conflicto. |
| indexingPolicy | Es la configuración de la directiva de indexación para la recopilación. |
Propiedades en Directiva de indexación
| Propiedad | Descripción |
|---|---|
| Automático | Indica si la indexación automática está activada o desactivada. El valor predeterminado es True, por lo que se indexan todos los documentos. Establecer el valor en False permitiría la configuración manual de las rutas de indización. |
| indexingMode | De forma predeterminada, el modo de indexación es Coherente. Esto significa que la indexación se produce de forma sincrónica durante la inserción, sustitución o eliminación de documentos. Para que la indización se produzca de forma asincrónica, establezca el modo de indización en lazy. |
| includedPaths | La matriz que contiene las rutas de acceso del documento que se indexarán. De forma predeterminada, se incluyen dos rutas de acceso: la ruta de acceso / que especifica que se indexan todas las rutas de acceso del documento y la ruta de acceso _ts, que indexa para una comparación de intervalos de marca de tiempo. Dentro del elemento de la matriz. |
Propiedades en Ruta de acceso incluida
| Propiedad | Descripción |
|---|---|
| path | Ruta de acceso a la que se aplica el comportamiento de indexación. Las rutas de acceso de índice comienzan con la raíz (/) y suelen terminar con el operador comodín de signo de interrogación (?), lo que indica que hay varios valores posibles para el prefijo. Por ejemplo, para atender la consulta SELECT * FROM Families F WHERE F.familyName = "Andersen", debe incluir una ruta de acceso de índice para /familyName/? en la directiva de índice de la colección. Las rutas de acceso del índice también pueden usar el operador comodín * para especificar el comportamiento de las rutas de acceso de forma recursiva en el prefijo. Por ejemplo, /payload/* puede usarse para excluir de la indexación a todo el contenido de la propiedad payload. |
| dataType | Es el tipo de datos al que se aplica el comportamiento de indexación. Puede ser String, Number, Point, Polygon o LineString. Los valores Booleans y null se indexan automáticamente |
| kind | Tipo de índice. Los índices hash son útiles para las comparaciones de igualdad, mientras que los índices range son útiles para la igualdad, las comparaciones de intervalos y la ordenación. Los índices espaciales son útiles para las consultas espaciales. |
| precisión | Precisión del índice. Se puede establecer en -1 para la precisión máxima o entre 1 y 8 para Number y 1-100 para String. No es aplicable a los tipos de datos Point, Polygon y LineString . |
Propiedades en Clave de partición
| Propiedad | Descripción |
|---|---|
| Rutas de acceso | Matriz de rutas de acceso mediante las que se pueden particionar los datos de la colección. Las rutas de acceso no deben contener un carácter comodín ni una barra diagonal final. Por ejemplo, la propiedad JSON "AccountNumber" se especifica como "/AccountNumber". La matriz solo debe contener un valor único. |
| kind | Algoritmo utilizado para la creación de particiones. Solo se admite hash . |
{
"id": "testcoll",
"indexingPolicy": {
"indexingMode": "consistent",
"automatic": true,
"includedPaths": [
{
"path": "/*",
"indexes": [
{
"kind": "Range",
"dataType": "String",
"precision": -1
},
{
"kind": "Range",
"dataType": "Number",
"precision": -1
}
]
}
],
"excludedPaths": []
},
"partitionKey": {
"paths": [
"/AccountNumber"
],
"kind": "Hash"
},
"_rid": "1tAvAP4XWww=",
"_ts": 1459198933,
"_self": "dbs/1tAvAA==/colls/1tAvAP4XWww=/",
"_etag": "\"00005600-0000-0000-0000-56f99bd50000\"",
"_docs": "docs/",
"_sprocs": "sprocs/",
"_triggers": "triggers/",
"_udfs": "udfs/",
"_conflicts": "conflicts/"
}
Ejemplo
GET https://querydemo.documents.azure.com/dbs/testdb/colls HTTP/1.1
x-ms-offer-throughput: 1000
x-ms-date: Mon, 28 Mar 2016 21:02:12 GMT
authorization: type%3dmaster%26ver%3d1.0%26sig%3dP8r7%2fEZnOxv2wQr2smp4G1tCH9PkOkIZscHqsqdn6y4%3d
Cache-Control: no-cache
User-Agent: Microsoft.Azure.Documents.Client/1.6.0.0
x-ms-version: 2015-12-16
Accept: application/json
Host: querydemo.documents.azure.com
Content-Length: 235
Expect: 100-continue
HTTP/1.1 201 Created
Cache-Control: no-store, no-cache
Pragma: no-cache
Transfer-Encoding: chunked
Content-Type: application/json
Server: Microsoft-HTTPAPI/2.0
Strict-Transport-Security: max-age=31536000
x-ms-last-state-change-utc: Mon, 28 Mar 2016 20:10:13.601 GMT
etag: "00005600-0000-0000-0000-56f99bd50000"
collection-partition-index: 0
collection-service-index: 24
x-ms-schemaversion: 1.1
x-ms-alt-content-path: dbs/testdb
x-ms-quorum-acked-lsn: 6
x-ms-current-write-quorum: 3
x-ms-current-replica-set-size: 4
x-ms-request-charge: 4.95
x-ms-serviceversion: version=1.6.52.5
x-ms-activity-id: fbc3f36d-15d5-45fa-8f19-8579945451f8
x-ms-session-token: 0:7
Set-Cookie: x-ms-session-token#0=7; Domain=querydemo.documents.azure.com; Path=/dbs/1tAvAA==/colls/1tAvAP4XWww=
Set-Cookie: x-ms-session-token=7; Domain=querydemo.documents.azure.com; Path=/dbs/1tAvAA==/colls/1tAvAP4XWww=
x-ms-gatewayversion: version=1.6.52.5
Date: Mon, 28 Mar 2016 21:02:13 GMT
{
"id": "testcoll",
"indexingPolicy": {
"indexingMode": "consistent",
"automatic": true,
"includedPaths": [
{
"path": "/*",
"indexes": [
{
"kind": "Range",
"dataType": "String",
"precision": -1
},
{
"kind": "Range",
"dataType": "Number",
"precision": -1
}
]
}
],
"excludedPaths": []
},
"partitionKey": {
"paths": [
"/AccountNumber"
],
"kind": "Hash"
},
"_rid": "1tAvAP4XWww=",
"_ts": 1459198933,
"_self": "dbs/1tAvAA==/colls/1tAvAP4XWww=/",
"_etag": "\"00005600-0000-0000-0000-56f99bd50000\"",
"_docs": "docs/",
"_sprocs": "sprocs/",
"_triggers": "triggers/",
"_udfs": "udfs/",
"_conflicts": "conflicts/"
}