Trabajar con índices secundarios globales: .NET - Amazon DynamoDB

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Trabajar con índices secundarios globales: .NET

Puede utilizar la API de bajo nivel AWS SDK for .NET para crear una tabla Amazon DynamoDB con uno o varios índices secundarios globales, describir los índices de la tabla y utilizarlos para realizar consultas. Estas operaciones se mapean a las operaciones correspondientes de DynamoDB. Para obtener más información, consulte la Referencia de la API de Amazon DynamoDB.

A continuación se indican los pasos comunes para las operaciones con tablas mediante el API de bajo nivel de .NET.

  1. Cree una instancia de la clase AmazonDynamoDBClient.

  2. Cree los objetos de solicitud correspondientes para proporcionar los parámetros obligatorios y opcionales de la operación.

    Por ejemplo, cree un objeto CreateTableRequest para crear una tabla y un objeto QueryRequest para consultar una tabla o un índice.

  3. Ejecute el método apropiado proporcionado por el cliente que ha creado en el paso anterior.

Creación de una tabla con un índice secundario global

Puede crear índices secundarios globales a la vez que crea la tabla. Para ello, utilice CreateTable e indique las especificaciones para uno o varios índices secundarios globales. En el ejemplo de código C# siguiente, se crea una tabla para contener información sobre datos meteorológicos. La clave de partición es Location y la de ordenación, Date. Un índice secundario global denominado PrecipIndex permite obtener acceso rápido a los datos sobre precipitaciones de varias ubicaciones.

A continuación se indican los pasos que hay que seguir para crear una tabla con un índice secundario global mediante el API de bajo nivel de .NET.

  1. Cree una instancia de la clase AmazonDynamoDBClient.

  2. Cree una instancia de la clase CreateTableRequest para proporcionar la información de solicitud.

    Debe proporcionar el nombre de la tabla, su clave principal y los valores de rendimiento aprovisionado. Para el índice secundario global, debe proporcionar el nombre del índice, los ajustes de rendimiento aprovisionado, las definiciones de atributos de la clave de ordenación del índice, el esquema de claves del índice y la proyección de atributos.

  3. Ejecute el método CreateTable proporcionando el objeto de solicitud como parámetro.

En el siguiente ejemplo de código C# se ponen en práctica los pasos anteriores. El código crea una tabla (WeatherData) con un índice secundario global (PrecipIndex). La clave de partición del índice es Date y la de ordenación, Precipitation. Todos los atributos de la tabla se proyectan en el índice. Los usuarios pueden consultar este índice para obtener los datos meteorológicos de una determinada fecha y, si lo desean, ordenarlos según la cantidad de precipitación.

Ya que Precipitation no es un atributo de clave para la tabla, no es obligatorio. Sin embargo, los elementosWeatherData sin Precipitation no aparecen en PrecipIndex.

client = new AmazonDynamoDBClient(); string tableName = "WeatherData"; // Attribute definitions var attributeDefinitions = new List<AttributeDefinition>() { {new AttributeDefinition{ AttributeName = "Location", AttributeType = "S"}}, {new AttributeDefinition{ AttributeName = "Date", AttributeType = "S"}}, {new AttributeDefinition(){ AttributeName = "Precipitation", AttributeType = "N"} } }; // Table key schema var tableKeySchema = new List<KeySchemaElement>() { {new KeySchemaElement { AttributeName = "Location", KeyType = "HASH"}}, //Partition key {new KeySchemaElement { AttributeName = "Date", KeyType = "RANGE"} //Sort key } }; // PrecipIndex var precipIndex = new GlobalSecondaryIndex { IndexName = "PrecipIndex", ProvisionedThroughput = new ProvisionedThroughput { ReadCapacityUnits = (long)10, WriteCapacityUnits = (long)1 }, Projection = new Projection { ProjectionType = "ALL" } }; var indexKeySchema = new List<KeySchemaElement> { {new KeySchemaElement { AttributeName = "Date", KeyType = "HASH"}}, //Partition key {new KeySchemaElement{AttributeName = "Precipitation",KeyType = "RANGE"}} //Sort key }; precipIndex.KeySchema = indexKeySchema; CreateTableRequest createTableRequest = new CreateTableRequest { TableName = tableName, ProvisionedThroughput = new ProvisionedThroughput { ReadCapacityUnits = (long)5, WriteCapacityUnits = (long)1 }, AttributeDefinitions = attributeDefinitions, KeySchema = tableKeySchema, GlobalSecondaryIndexes = { precipIndex } }; CreateTableResponse response = client.CreateTable(createTableRequest); Console.WriteLine(response.CreateTableResult.TableDescription.TableName); Console.WriteLine(response.CreateTableResult.TableDescription.TableStatus);

Debe esperar hasta que DynamoDB cree la tabla y establezca el estado de esta última en ACTIVE. A partir de ese momento, puede comenzar a incluir elementos de datos en la tabla.

Descripción de una tabla con un índice secundario global

Para obtener información sobre los índices secundarios globales en una tabla, use DescribeTable. Para cada índice, puede obtener acceso a su nombre, esquema de claves y atributos proyectados.

A continuación se indican los pasos que hay que seguir para acceder a la información de un índice secundario global de una tabla mediante el API de bajo nivel de .NET.

  1. Cree una instancia de la clase AmazonDynamoDBClient.

  2. Ejecute el método describeTable proporcionando el objeto de solicitud como parámetro.

    Cree una instancia de la clase DescribeTableRequest para proporcionar la información de solicitud. Debe proporcionar el nombre de la tabla.

En el siguiente ejemplo de código C# se ponen en práctica los pasos anteriores.

ejemplo
client = new AmazonDynamoDBClient(); string tableName = "WeatherData"; DescribeTableResponse response = client.DescribeTable(new DescribeTableRequest { TableName = tableName}); List<GlobalSecondaryIndexDescription> globalSecondaryIndexes = response.DescribeTableResult.Table.GlobalSecondaryIndexes; // This code snippet will work for multiple indexes, even though // there is only one index in this example. foreach (GlobalSecondaryIndexDescription gsiDescription in globalSecondaryIndexes) { Console.WriteLine("Info for index " + gsiDescription.IndexName + ":"); foreach (KeySchemaElement kse in gsiDescription.KeySchema) { Console.WriteLine("\t" + kse.AttributeName + ": key type is " + kse.KeyType); } Projection projection = gsiDescription.Projection; Console.WriteLine("\tThe projection type is: " + projection.ProjectionType); if (projection.ProjectionType.ToString().Equals("INCLUDE")) { Console.WriteLine("\t\tThe non-key projected attributes are: " + projection.NonKeyAttributes); } }

Consulta de un índice secundario local

Puede utilizar Query en un índice secundario global, de un modo bastante similar al que realiza una Query en una tabla. Debe especificar el nombre del índice, los criterios de consulta de la clave de partición y la clave de ordenación (si procede) del índice y los atributos que desea devolver. En este ejemplo, el índice es PrecipIndex, cuyas clave de partición y ordenación son, respectivamente, Date y Precipitation. La consulta del índice devuelve todos los datos meteorológicos de una determinada fecha cuando el valor de Precipitation sea mayor que cero.

A continuación se indican los pasos que hay que seguir para consultar un índice secundario global mediante el API de bajo nivel de .NET.

  1. Cree una instancia de la clase AmazonDynamoDBClient.

  2. Cree una instancia de la clase QueryRequest para proporcionar la información de solicitud.

  3. Ejecute el método query proporcionando el objeto de solicitud como parámetro.

El nombre de atributo Date es una palabra reservada de DynamoDB. Por consiguiente, debe usar un nombre de atributo de expresión como marcador de posición en la expresión KeyConditionExpression.

En el siguiente ejemplo de código C# se ponen en práctica los pasos anteriores.

ejemplo
client = new AmazonDynamoDBClient(); QueryRequest queryRequest = new QueryRequest { TableName = "WeatherData", IndexName = "PrecipIndex", KeyConditionExpression = "#dt = :v_date and Precipitation > :v_precip", ExpressionAttributeNames = new Dictionary<String, String> { {"#dt", "Date"} }, ExpressionAttributeValues = new Dictionary<string, AttributeValue> { {":v_date", new AttributeValue { S = "2013-08-01" }}, {":v_precip", new AttributeValue { N = "0" }} }, ScanIndexForward = true }; var result = client.Query(queryRequest); var items = result.Items; foreach (var currentItem in items) { foreach (string attr in currentItem.Keys) { Console.Write(attr + "---> "); if (attr == "Precipitation") { Console.WriteLine(currentItem[attr].N); } else { Console.WriteLine(currentItem[attr].S); } } Console.WriteLine(); }