Function get

  • Create a map to get one or more items using transactGet.

    Returns

    A map in the format { Get: { TableName: ..., Key: ... } }

    Parameters

    • tableName: string

      The name of the table that contains the item

    • key: Key

      A map of attribute names to values that specifies the primary key of the item to retrieve

    • Optional options: Partial<Get>

      The same parameters accepted by the original Document.transactGet items

    Returns { Get: { ExpressionAttributeNames?: ExpressionAttributeNameMap; Key: Key; ProjectionExpression?: string; TableName: string } }

    • Get: { ExpressionAttributeNames?: ExpressionAttributeNameMap; Key: Key; ProjectionExpression?: string; TableName: string }
      • Optional ExpressionAttributeNames?: ExpressionAttributeNameMap

        One or more substitution tokens for attribute names in the ProjectionExpression parameter.

      • Key: Key

        A map of attribute names to AttributeValue objects that specifies the primary key of the item to retrieve.

      • Optional ProjectionExpression?: string

        A string that identifies one or more attributes of the specified item to retrieve from the table. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes of the specified item are returned. If any of the requested attributes are not found, they do not appear in the result.

      • TableName: string

        The name of the table from which to retrieve the specified item.

Settings

Member Visibility

Theme

Generated using TypeDoc