Was this page helpful?
ScyllaDB Python Driver is available under the Apache v2 License. ScyllaDB Python Driver is a fork of DataStax Python Driver. See Copyright here.
Caution
You're viewing documentation for a deprecated version of Scylla Python Driver. Switch to the latest stable version.
cassandra.util - Utilities¶Creates a timezone-agnostic datetime from timestamp (in seconds) in a consistent manner. Works around a Windows issue with large negative timestamps (PYTHON-119), and rounding differences in Python 3.4 (PYTHON-340).
timestamp – a unix timestamp, in seconds
Creates a UTC datetime from a timestamp in milliseconds. See
datetime_from_timestamp().
Raises an OverflowError if the timestamp is out of range for
datetime.
timestamp – timestamp, in milliseconds
Converts a datetime to a timestamp expressed in milliseconds.
dt – a datetime.datetime
Converts a version 1 uuid.UUID to a timestamp with the same precision
as time.time() returns. This is useful for examining the
results of queries returning a v1 UUID.
uuid_arg – a version 1 UUID
Creates a timezone-agnostic datetime from the timestamp in the specified type-1 UUID.
uuid_arg – a version 1 UUID
Generates the minimum TimeUUID (type 1) for a given timestamp, as compared by Cassandra.
See uuid_from_time() for argument and return types.
Generates the maximum TimeUUID (type 1) for a given timestamp, as compared by Cassandra.
See uuid_from_time() for argument and return types.
Converts a datetime or timestamp to a type 1 uuid.UUID.
time_arg – The time to use for the timestamp portion of the UUID.
This can either be a datetime object or a timestamp
in seconds (as returned from time.time()).
node (long) – None integer for the UUID (up to 48 bits). If not specified, this field is randomized.
clock_seq (int) – Clock sequence field for the UUID (up to 14 bits). If not specified, a random sequence is generated.
uuid.UUID
The lowest possible TimeUUID, as sorted by Cassandra.
The highest possible TimeUUID, as sorted by Cassandra.
A sorted set based on sorted list
A sorted set implementation is used in this case because it does not require its elements to be immutable/hashable.
#Not implemented: update functions, inplace operators
An ordered map that accepts non-hashable types for keys. It also maintains the insertion order of items, behaving as OrderedDict in that regard. These maps are constructed and read just as normal mapping types, except that they may contain arbitrary collections and other non-hashable items as keys:
>>> od = OrderedMap([({'one': 1, 'two': 2}, 'value'),
... ({'three': 3, 'four': 4}, 'value2')])
>>> list(od.keys())
[{'two': 2, 'one': 1}, {'three': 3, 'four': 4}]
>>> list(od.values())
['value', 'value2']
These constructs are needed to support nested collections in Cassandra 2.1.3+, where frozen collections can be specified as parameters to others:
CREATE TABLE example (
...
value map<frozen<map<int, int>>, double>
...
)
This class derives from the (immutable) Mapping API. Objects in these maps are not intended be modified.
Idealized time, independent of day.
Up to nanosecond resolution
Initializer value can be:
integer_type: absolute nanoseconds in the day
datetime.time: built-in time
string_type: a string time of the form “HH:MM:SS[.mmmuuunnn]”
The hour component of this time (0-23)
The minute component of this time (0-59)
The second component of this time (0-59)
The fractional seconds component of the time, in nanoseconds
Return a built-in datetime.time (nanosecond precision truncated to micros).
Idealized date: year, month, day
Offers wider year range than datetime.date. For Dates that cannot be represented as a datetime.date (because datetime.MINYEAR, datetime.MAXYEAR), this type falls back to printing days_from_epoch offset.
Initializer value can be:
integer_type: absolute days from epoch (1970, 1, 1). Can be negative.
datetime.date: built-in date
string_type: a string time of the form “yyyy-mm-dd”
Absolute seconds from epoch (can be negative)
Return a built-in datetime.date for Dates falling in the years [datetime.MINYEAR, datetime.MAXYEAR]
ValueError is raised for Dates outside this range.
Represents a point geometry for DSE
x coordinate of the point
y coordinate of the point
Parse a Point geometry from a wkt string and return a new Point object.
Represents a linestring geometry for DSE
‘coords`: a sequence of (x, y) coordinates of points in the linestring
Tuple of (x, y) coordinates in the linestring
Parse a LineString geometry from a wkt string and return a new LineString object.
Represents a polygon geometry for DSE
‘exterior`: a sequence of (x, y) coordinates of points in the linestring interiors: None, or a sequence of sequences or (x, y) coordinates of points describing interior linear rings
_LinearRing representing the exterior of the polygon
Tuple of _LinearRings representing interior holes in the polygon
Parse a Polygon geometry from a wkt string and return a new Polygon object.
Represents a Distance geometry for DSE
x coordinate of the center point
y coordinate of the center point
radius to represent the distance from the center point
Parse a Distance geometry from a wkt string and return a new Distance object.
Cassandra Duration Type
An “enum” representing the valid values for DateRange.precision.
Represents a single date value and its precision for DateRange.
Integer representing milliseconds since the UNIX epoch. May be negative.
String representing the precision of a bound. Must be a valid
DateRangePrecision member.
DateRangeBound uses a millisecond offset from the UNIX epoch to
allow DateRange to represent values datetime.datetime cannot.
For such values, string representions will show this offset rather than the
CQL representation.
value – a value representing ms since the epoch. Accepts an integer or a datetime.
precision – a string representing precision
Return milliseconds as a datetime.datetime if possible.
Raises an OverflowError if the value is out of range.
Construct a new DateRangeBound from a given value. If
possible, use the value[‘milliseconds’] and value[‘precision’] keys
of the argument. Otherwise, use the argument as a (milliseconds,
precision) iterable.
value – a dictlike or iterable object
Represents *, an open value or bound for DateRange.
DSE DateRange Type
DateRangeBound representing the lower bound of a bounded range.
DateRangeBound representing the upper bound of a bounded range.
DateRangeBound representing the value of a single-value range.
As noted in its documentation, DateRangeBound uses a millisecond
offset from the UNIX epoch to allow DateRange to represent values
datetime.datetime cannot. For such values, string representions will show
this offset rather than the CQL representation.
lower_bound – a DateRangeBound or object accepted by
DateRangeBound.from_value() to be used as a
lower_bound. Mutually exclusive with value. If
upper_bound is specified and this is not, the lower_bound
will be open.
upper_bound – a DateRangeBound or object accepted by
DateRangeBound.from_value() to be used as a
upper_bound. Mutually exclusive with value. If
lower_bound is specified and this is not, the upper_bound
will be open.
value – a DateRangeBound or object accepted by
DateRangeBound.from_value() to be used as value. Mutually
exclusive with lower_bound and lower_bound.
Internal minimalist class to compare versions. A valid version is: <int>.<int>.<int>.<int or str>.
TODO: when python2 support is removed, use packaging.version.
Was this page helpful?
ScyllaDB Python Driver is available under the Apache v2 License. ScyllaDB Python Driver is a fork of DataStax Python Driver. See Copyright here.
cassandra - Exceptions and Enumscassandra.cluster - Clusters and Sessionscassandra.policies - Load balancing and Failure Handling Policiescassandra.auth - Authenticationcassandra.graph - Graph Statements, Options, and Row Factoriescassandra.metadata - Schema and Ring Topologycassandra.metrics - Performance Metricscassandra.query - Prepared Statements, Batch Statements, Tracing, and Row Factoriescassandra.pool - Hosts and Connection Poolscassandra.protocol - Protocol Featurescassandra.encoder - Encoders for non-prepared Statementscassandra.decoder - Data Return Formatscassandra.concurrent - Utilities for Concurrent Statement Executioncassandra.connection - Low Level Connection Infocassandra.util - Utilitiescassandra.timestamps - Timestamp Generationcassandra.io.asyncioreactor - asyncio Event Loopcassandra.io.asyncorereactor - asyncore Event Loopcassandra.io.eventletreactor - eventlet-compatible Connectioncassandra.io.libevreactor - libev Event Loopcassandra.io.geventreactor - gevent-compatible Event Loopcassandra.io.twistedreactor - Twisted Event Loopcassandra.cqlengine.models - Table models for object mappingcassandra.cqlengine.columns - Column types for object mapping modelscassandra.cqlengine.query - Query and filter model objectscassandra.cqlengine.connection - Connection management for cqlenginecassandra.cqlengine.management - Schema management for cqlenginecassandra.cqlengine.usertype - Model classes for User Defined Typescassandra.datastax.graph - Graph Statements, Options, and Row Factoriescassandra.datastax.graph.fluentcassandra.datastax.graph.fluent.querycassandra.datastax.graph.fluent.predicatesOn this page
cassandra.util - Utilitiesdatetime_from_timestamp()utc_datetime_from_ms_timestamp()ms_timestamp_from_datetime()unix_time_from_uuid1()datetime_from_uuid1()min_uuid_from_time()max_uuid_from_time()uuid_from_time()LOWEST_TIME_UUIDHIGHEST_TIME_UUIDSortedSetsortedsetOrderedMapOrderedMapSerializedKeyTime
Date
Point
LineString
Polygon
Distance
Duration
DateRangePrecision
DateRangeBound
OPEN_BOUNDDateRange
Version