|
Server : Apache System : Linux iad1-shared-b8-43 6.6.49-grsec-jammy+ #10 SMP Thu Sep 12 23:23:08 UTC 2024 x86_64 User : dh_edsupp ( 6597262) PHP Version : 8.2.26 Disable Function : NONE Directory : /lib/python3/dist-packages/boto/dynamodb/__pycache__/ |
Upload File : |
o
ckF[0U � @ s\ d dl mZ d dlmZ d dlmZ d dlmZ d dl Z G dd� de
�Z G dd � d e
�Z dS )
� )� BatchList)�Schema)�Item)�
exceptionsNc @ s. e Zd ZdZ d
dd�Zdd� Zdd � ZdS ) �TableBatchGeneratorz�
A low-level generator used to page through results from
batch_get_item operations.
:ivar consumed_units: An integer that holds the number of
ConsumedCapacityUnits accumulated thus far for this
generator.
NFc C s" || _ || _d| _|| _|| _d S )Nr )�table�keys�consumed_units�attributes_to_get�consistent_read)�selfr r r
r � r
�5/usr/lib/python3/dist-packages/boto/dynamodb/table.py�__init__) s
z TableBatchGenerator.__init__c C sn d|vrd S | j j|d vrd S |d | j j d }|D ]}|d }d|v r*|d nd }| j�||f� q d S )N�UnprocessedKeys�Keys�HashKeyElement�RangeKeyElement)r �namer �append)r �resr �key�h�rr
r
r �_queue_unprocessed1 s �z&TableBatchGenerator._queue_unprocessedc c s� � | j rVt| jj�}|�| j| j d d� | j� |�� }| jj|d vr%q| j|d | jj d 7 _|d | jj d D ]}|V q>| j dd � | _ | � |� | j sd S d S )N�d � Responses�ConsumedCapacityUnits�Items)
r r r �layer2� add_batchr
�submitr r r )r �batchr �elemr
r
r �__iter__> s � �
�z TableBatchGenerator.__iter__�NF)�__name__�
__module__� __qualname__�__doc__r r r$ r
r
r
r r s
�
r c @ s� e Zd ZdZdd� Zedd� �Zdd� Zedd � �Z ed
d � �Z
ed d
� �Z edd� �Z edd� �Z
edd� �Zedd� �Zedd� �Zdd� Zd/d d �Zd d � Zd d!� Zd"d"defd#d$�ZeZd0d%d&�Zd"d"d"efd'd(�Zd)d*� Zd+d,� Zd1d-d.�Z d"S )2�Tablea�
An Amazon DynamoDB table.
:ivar name: The name of the table.
:ivar create_time: The date and time that the table was created.
:ivar status: The current status of the table. One of:
'ACTIVE', 'UPDATING', 'DELETING'.
:ivar schema: A :class:`boto.dynamodb.schema.Schema` object representing
the schema defined for the table.
:ivar item_count: The number of items in the table. This value is
set only when the Table object is created or refreshed and
may not reflect the actual count.
:ivar size_bytes: Total size of the specified table, in bytes.
Amazon DynamoDB updates this value approximately every six hours.
Recent changes might not be reflected in this value.
:ivar read_units: The ReadCapacityUnits of the tables
Provisioned Throughput.
:ivar write_units: The WriteCapacityUnits of the tables
Provisioned Throughput.
:ivar schema: The Schema object associated with the table.
c C s || _ i | _| �|� dS )z�
:type layer2: :class:`boto.dynamodb.layer2.Layer2`
:param layer2: A `Layer2` api object.
:type response: dict
:param response: The output of
`boto.dynamodb.layer1.Layer1.describe_table`.
N)r �_dict�update_from_response)r r �responser
r
r r i s zTable.__init__c C s | |dd|ii�}||_ |S )aW Create a Table object.
If you know the name and schema of your table, you can
create a ``Table`` object without having to make any
API calls (normally an API call is made to retrieve
the schema of a table).
Example usage::
table = Table.create_from_schema(
boto.connect_dynamodb(),
'tablename',
Schema.create(hash_key=('keyname', 'N')))
:type layer2: :class:`boto.dynamodb.layer2.Layer2`
:param layer2: A ``Layer2`` api object.
:type name: str
:param name: The name of the table.
:type schema: :class:`boto.dynamodb.schema.Schema`
:param schema: The schema associated with the table.
:rtype: :class:`boto.dynamodb.table.Table`
:return: A Table object representing the table.
r* � TableName��_schema)�clsr r �schemar r
r
r �create_from_schemax s zTable.create_from_schemac C s
d| j S )Nz Table(%s))r �r r
r
r �__repr__� s
zTable.__repr__c C s
| j d S )Nr. )r+ r4 r
r
r r � s
z
Table.namec C � | j �dd �S )N�CreationDateTime�r+ �getr4 r
r
r � create_time� � zTable.create_timec C r6 )N� TableStatusr8 r4 r
r
r �status� r; z Table.statusc C � | j �dd�S )N� ItemCountr r8 r4 r
r
r �
item_count� r; zTable.item_countc C r> )N�TableSizeBytesr r8 r4 r
r
r �
size_bytes� r; zTable.size_bytesc C s | j S �Nr/ r4 r
r
r r2 � s z Table.schemac C �& z| j d d W S ty Y d S w )N�ProvisionedThroughput�ReadCapacityUnits�r+ �KeyErrorr4 r
r
r �
read_units� �
�zTable.read_unitsc C rD )NrE �WriteCapacityUnitsrG r4 r
r
r � write_units� rJ zTable.write_unitsc C sT d|v r
| j �|d � n d|v r| j �|d � d| j v r(t| j d �| _dS dS )zx
Update the state of the Table object based on the response
data received from Amazon DynamoDB.
r* �TableDescription� KeySchemaN)r+ �updater r0 )r r- r
r
r r, � s
�zTable.update_from_responseF� c C sP d}|s&| j �| j�}| �|� |r | jdkrd}nt�|� nd}|rdS dS )a6
Refresh all of the fields of the Table object by calling
the underlying DescribeTable request.
:type wait_for_active: bool
:param wait_for_active: If True, this command will not return
until the table status, as returned from Amazon DynamoDB, is
'ACTIVE'.
:type retry_seconds: int
:param retry_seconds: If wait_for_active is True, this
parameter controls the number of seconds of delay between
calls to update_table in Amazon DynamoDB. Default is 5 seconds.
F�ACTIVETN)r �describe_tabler r, r= �time�sleep)r �wait_for_active�
retry_seconds�doner- r
r
r �refresh� s
�z
Table.refreshc C s | j �| ||� dS )a
Update the ProvisionedThroughput for the Amazon DynamoDB Table.
:type read_units: int
:param read_units: The new value for ReadCapacityUnits.
:type write_units: int
:param write_units: The new value for WriteCapacityUnits.
N)r �update_throughput)r rI rL r
r
r rY � s
zTable.update_throughputc C s | j �| � dS )z�
Delete this table and all items in it. After calling this
the Table objects status attribute will be set to 'DELETING'.
N)r � delete_tabler4 r
r
r �delete� s z Table.deleteNc C s | j �| |||||�S )a�
Retrieve an existing item from the table.
:type hash_key: int|long|float|str|unicode|Binary
:param hash_key: The HashKey of the requested item. The
type of the value must match the type defined in the
schema for the table.
:type range_key: int|long|float|str|unicode|Binary
:param range_key: The optional RangeKey of the requested item.
The type of the value must match the type defined in the
schema for the table.
:type attributes_to_get: list
:param attributes_to_get: A list of attribute names.
If supplied, only the specified attribute names will
be returned. Otherwise, all attributes will be returned.
:type consistent_read: bool
:param consistent_read: If True, a consistent read
request is issued. Otherwise, an eventually consistent
request is issued.
:type item_class: Class
:param item_class: Allows you to override the class used
to generate the items. This should be a subclass of
:class:`boto.dynamodb.item.Item`
)r �get_item)r �hash_key� range_keyr
r �
item_classr
r
r r\ � s �zTable.get_itemc C s2 z
| j |||g|d� W dS tjy Y dS w )aC
Checks the table to see if the Item with the specified ``hash_key``
exists. This may save a tiny bit of time/bandwidth over a
straight :py:meth:`get_item` if you have no intention to touch
the data that is returned, since this method specifically tells
Amazon not to return anything but the Item's key.
:type hash_key: int|long|float|str|unicode|Binary
:param hash_key: The HashKey of the requested item. The
type of the value must match the type defined in the
schema for the table.
:type range_key: int|long|float|str|unicode|Binary
:param range_key: The optional RangeKey of the requested item.
The type of the value must match the type defined in the
schema for the table.
:type consistent_read: bool
:param consistent_read: If True, a consistent read
request is issued. Otherwise, an eventually consistent
request is issued.
:rtype: bool
:returns: ``True`` if the Item exists, ``False`` if not.
)r^ r
r FT)r\ �dynamodb_exceptions�DynamoDBKeyNotFoundError)r r] r^ r r
r
r �has_item" s ���zTable.has_itemc C s || |||�S )a�
Return an new, unsaved Item which can later be PUT to
Amazon DynamoDB.
This method has explicit (but optional) parameters for
the hash_key and range_key values of the item. You can use
these explicit parameters when calling the method, such as::
>>> my_item = my_table.new_item(hash_key='a', range_key=1,
attrs={'key1': 'val1', 'key2': 'val2'})
>>> my_item
{u'bar': 1, u'foo': 'a', 'key1': 'val1', 'key2': 'val2'}
Or, if you prefer, you can simply put the hash_key and range_key
in the attrs dictionary itself, like this::
>>> attrs = {'foo': 'a', 'bar': 1, 'key1': 'val1', 'key2': 'val2'}
>>> my_item = my_table.new_item(attrs=attrs)
>>> my_item
{u'bar': 1, u'foo': 'a', 'key1': 'val1', 'key2': 'val2'}
The effect is the same.
.. note:
The explicit parameters take priority over the values in
the attrs dict. So, if you have a hash_key or range_key
in the attrs dict and you also supply either or both using
the explicit parameters, the values in the attrs will be
ignored.
:type hash_key: int|long|float|str|unicode|Binary
:param hash_key: The HashKey of the new item. The
type of the value must match the type defined in the
schema for the table.
:type range_key: int|long|float|str|unicode|Binary
:param range_key: The optional RangeKey of the new item.
The type of the value must match the type defined in the
schema for the table.
:type attrs: dict
:param attrs: A dictionary of key value pairs used to
populate the new item.
:type item_class: Class
:param item_class: Allows you to override the class used
to generate the items. This should be a subclass of
:class:`boto.dynamodb.item.Item`
r
)r r] r^ �attrsr_ r
r
r �new_itemH s 3zTable.new_itemc O s | j j| |g|�R i |��S )a�
Perform a query on the table.
:type hash_key: int|long|float|str|unicode|Binary
:param hash_key: The HashKey of the requested item. The
type of the value must match the type defined in the
schema for the table.
:type range_key_condition: :class:`boto.dynamodb.condition.Condition`
:param range_key_condition: A Condition object.
Condition object can be one of the following types:
EQ|LE|LT|GE|GT|BEGINS_WITH|BETWEEN
The only condition which expects or will accept two
values is 'BETWEEN', otherwise a single value should
be passed to the Condition constructor.
:type attributes_to_get: list
:param attributes_to_get: A list of attribute names.
If supplied, only the specified attribute names will
be returned. Otherwise, all attributes will be returned.
:type request_limit: int
:param request_limit: The maximum number of items to retrieve
from Amazon DynamoDB on each request. You may want to set
a specific request_limit based on the provisioned throughput
of your table. The default behavior is to retrieve as many
results as possible per request.
:type max_results: int
:param max_results: The maximum number of results that will
be retrieved from Amazon DynamoDB in total. For example,
if you only wanted to see the first 100 results from the
query, regardless of how many were actually available, you
could set max_results to 100 and the generator returned
from the query method will only yeild 100 results max.
:type consistent_read: bool
:param consistent_read: If True, a consistent read
request is issued. Otherwise, an eventually consistent
request is issued.
:type scan_index_forward: bool
:param scan_index_forward: Specified forward or backward
traversal of the index. Default is forward (True).
:type exclusive_start_key: list or tuple
:param exclusive_start_key: Primary key of the item from
which to continue an earlier query. This would be
provided as the LastEvaluatedKey in that query.
:type count: bool
:param count: If True, Amazon DynamoDB returns a total
number of items for the Query operation, even if the
operation has no matching items for the assigned filter.
If count is True, the actual items are not returned and
the count is accessible as the ``count`` attribute of
the returned object.
:type item_class: Class
:param item_class: Allows you to override the class used
to generate the items. This should be a subclass of
:class:`boto.dynamodb.item.Item`
)r �query)r r] �args�kwr
r
r re } s Cz Table.queryc O s | j j| g|�R i |��S )a�
Scan through this table, this is a very long
and expensive operation, and should be avoided if
at all possible.
:type scan_filter: A dict
:param scan_filter: A dictionary where the key is the
attribute name and the value is a
:class:`boto.dynamodb.condition.Condition` object.
Valid Condition objects include:
* EQ - equal (1)
* NE - not equal (1)
* LE - less than or equal (1)
* LT - less than (1)
* GE - greater than or equal (1)
* GT - greater than (1)
* NOT_NULL - attribute exists (0, use None)
* NULL - attribute does not exist (0, use None)
* CONTAINS - substring or value in list (1)
* NOT_CONTAINS - absence of substring or value in list (1)
* BEGINS_WITH - substring prefix (1)
* IN - exact match in list (N)
* BETWEEN - >= first value, <= second value (2)
:type attributes_to_get: list
:param attributes_to_get: A list of attribute names.
If supplied, only the specified attribute names will
be returned. Otherwise, all attributes will be returned.
:type request_limit: int
:param request_limit: The maximum number of items to retrieve
from Amazon DynamoDB on each request. You may want to set
a specific request_limit based on the provisioned throughput
of your table. The default behavior is to retrieve as many
results as possible per request.
:type max_results: int
:param max_results: The maximum number of results that will
be retrieved from Amazon DynamoDB in total. For example,
if you only wanted to see the first 100 results from the
query, regardless of how many were actually available, you
could set max_results to 100 and the generator returned
from the query method will only yeild 100 results max.
:type count: bool
:param count: If True, Amazon DynamoDB returns a total
number of items for the Scan operation, even if the
operation has no matching items for the assigned filter.
If count is True, the actual items are not returned and
the count is accessible as the ``count`` attribute of
the returned object.
:type exclusive_start_key: list or tuple
:param exclusive_start_key: Primary key of the item from
which to continue an earlier query. This would be
provided as the LastEvaluatedKey in that query.
:type item_class: Class
:param item_class: Allows you to override the class used
to generate the items. This should be a subclass of
:class:`boto.dynamodb.item.Item`
:return: A TableGenerator (generator) object which will iterate
over all results
:rtype: :class:`boto.dynamodb.layer2.TableGenerator`
)r �scan)r rf rg r
r
r rh � s Dz
Table.scanc C s t | ||�S )a-
Return a set of attributes for a multiple items from a single table
using their primary keys. This abstraction removes the 100 Items per
batch limitations as well as the "UnprocessedKeys" logic.
:type keys: list
:param keys: A list of scalar or tuple values. Each element in the
list represents one Item to retrieve. If the schema for the
table has both a HashKey and a RangeKey, each element in the
list should be a tuple consisting of (hash_key, range_key). If
the schema for the table contains only a HashKey, each element
in the list should be a scalar value of the appropriate type
for the table schema. NOTE: The maximum number of items that
can be retrieved for a single operation is 100. Also, the
number of items retrieved is constrained by a 1 MB size limit.
:type attributes_to_get: list
:param attributes_to_get: A list of attribute names.
If supplied, only the specified attribute names will
be returned. Otherwise, all attributes will be returned.
:return: A TableBatchGenerator (generator) object which will
iterate over all results
:rtype: :class:`boto.dynamodb.table.TableBatchGenerator`
)r )r r r
r
r
r �batch_get_item s zTable.batch_get_item)FrP r% rC ) r& r' r( r) r � classmethodr3 r5 �propertyr r: r= r@ rB r2 rI rL r, rX rY r[ r r\ �lookuprb rd re rh ri r
r
r
r r* R sL
�"
&
�5EFr* )
�boto.dynamodb.batchr �boto.dynamodb.schemar �boto.dynamodb.itemr �
boto.dynamodbr r` rS �objectr r* r
r
r
r �<module> s 3