django.contrib.gis.db.backends.spatialite.operations.SpatiaLiteOperations

class documentation

class SpatiaLiteOperations(BaseSpatialOperations, DatabaseOperations): (source)

View In Hierarchy

Undocumented

Method convert_extent Convert the polygon data received from SpatiaLite to min/max values.
Method geo_db_type Return None because geometry columns are added via the `AddGeometryColumn` stored procedure on SpatiaLite.
Method geom_lib_version Return the version of the version-dependant geom library used by SpatiaLite.
Method geometry_columns Undocumented
Method geos_version Return the version of GEOS used by SpatiaLite as a string.
Method get_distance Return the distance parameters for the given geometry field, lookup value, and lookup type.
Method get_geometry_converter Undocumented
Method lwgeom_version Return the version of LWGEOM library used by SpatiaLite.
Method proj_version Return the version of the PROJ library used by SpatiaLite.
Method rttopo_version Return the version of RTTOPO library used by SpatiaLite.
Method spatial_aggregate_name Return the spatial aggregate SQL template and function for the given Aggregate instance.
Method spatial_ref_sys Undocumented
Method spatialite_version Return the SpatiaLite library version as a string.
Method spatialite_version_tuple Return the SpatiaLite version as a tuple (version string, major, minor, subminor).
Class Variable collect Undocumented
Class Variable disallowed_aggregates Undocumented
Class Variable extent Undocumented
Class Variable from_text Undocumented
Class Variable function_names Undocumented
Class Variable gis_operators Undocumented
Class Variable makeline Undocumented
Class Variable name Undocumented
Class Variable select Undocumented
Class Variable spatialite Undocumented
Class Variable unionagg Undocumented
Property spatial_version Determine the version of the SpatiaLite library.
Property unsupported_functions Undocumented
Method _get_spatialite_func Helper routine for calling SpatiaLite functions and returning their result. Any error occurring in this method should be handled by the caller.

Inherited from BaseSpatialOperations:

Method check_expression_support Undocumented
Method convert_extent3d Undocumented
Method geo_quote_name Undocumented
Method get_area_att_for_field Undocumented
Method get_db_converters Undocumented
Method get_distance_att_for_field Undocumented
Method get_geom_placeholder Return the placeholder for the given geometry field with the given value. Depending on the spatial backend, the placeholder may contain a stored procedure call to the transformation function of the spatial backend.
Method spatial_function_name Undocumented
Class Variable distance_expr_for_lookup Undocumented
Class Variable geom_func_prefix Undocumented
Class Variable mariadb Undocumented
Class Variable mysql Undocumented
Class Variable oracle Undocumented
Class Variable postgis Undocumented
Property select_extent Undocumented

Inherited from DatabaseOperations (via BaseSpatialOperations):

Method adapt_datetimefield_value Transform a datetime value to an object compatible with what is expected by the backend driver for datetime columns.
Method adapt_timefield_value Transform a time value to an object compatible with what is expected by the backend driver for time columns.
Method bulk_batch_size SQLite has a compile-time default (SQLITE_LIMIT_VARIABLE_NUMBER) of 999 variables per query.
Method bulk_insert_sql Undocumented
Method combine_duration_expression Undocumented
Method combine_expression Combine a list of subexpressions into a single expression, using the provided connecting operator. This is required because operators can vary between backends (e.g., Oracle with %% and &) and between subexpression types (e...
Method convert_booleanfield_value Undocumented
Method convert_datefield_value Undocumented
Method convert_datetimefield_value Undocumented
Method convert_timefield_value Undocumented
Method convert_uuidfield_value Undocumented
Method date_extract_sql Support EXTRACT with a user-defined function django_date_extract() that's registered in connect(). Use single quotes because this is a string and could otherwise cause a collision with a field name.
Method date_trunc_sql Given a lookup_type of 'year', 'month', or 'day', return the SQL that truncates the given date or datetime field field_name to a date object with only the given specificity.
Method datetime_cast_date_sql Return the SQL to cast a datetime value to date value.
Method datetime_cast_time_sql Return the SQL to cast a datetime value to time value.
Method datetime_extract_sql Given a lookup_type of 'year', 'month', 'day', 'hour', 'minute', or 'second', return the SQL that extracts a value from the given datetime field field_name.
Method datetime_trunc_sql Given a lookup_type of 'year', 'month', 'day', 'hour', 'minute', or 'second', return the SQL that truncates the given datetime field field_name to a datetime object with only the given specificity.
Method fetch_returned_insert_rows Given a cursor object that has just performed an INSERT...RETURNING statement into a table, return the list of returned data.
Method format_for_duration_arithmetic Do nothing since formatting is handled in the custom function.
Method get_decimalfield_converter Undocumented
Method insert_statement Undocumented
Method integer_field_range Given an integer field internal type (e.g. 'PositiveIntegerField'), return a tuple of the (min_value, max_value) form representing the range of the column type bound to the field.
Method last_executed_query Return a string of the query last executed by the given cursor, with placeholders replaced with actual values.
Method no_limit_value Return the value to use for the LIMIT when we are wanting "LIMIT infinity". Return None if the limit clause can be omitted in this case.
Method on_conflict_suffix_sql Undocumented
Method pk_default_value Return the value to use during an INSERT statement to specify that the field should use its default value.
Method quote_name Return a quoted version of the given table, index, or column name. Do not quote the given name if it's already been quoted.
Method return_insert_columns For backends that support returning columns as part of an insert query, return the SQL and params to append to the INSERT query. The returned fragment should contain a format string to hold the appropriate column.
Method sequence_reset_by_name_sql Return a list of the SQL statements required to reset sequences passed in `sequences`.
Method sql_flush Return a list of SQL statements required to remove all data from the given database tables (without actually removing the tables themselves).
Method subtract_temporals Undocumented
Method time_extract_sql Given a lookup_type of 'hour', 'minute', or 'second', return the SQL that extracts a value from the given time field field_name.
Method time_trunc_sql Given a lookup_type of 'hour', 'minute' or 'second', return the SQL that truncates the given time or datetime field field_name to a time object with only the given specificity.
Class Variable cast_char_field_without_max_length Undocumented
Class Variable cast_data_types Undocumented
Class Variable explain_prefix Undocumented
Class Variable jsonfield_datatype_values Undocumented
Method __references_graph Undocumented
Method _convert_tznames_to_sql Undocumented
Method _quote_params_for_last_executed_query Only for last_executed_query! Don't use this to execute SQL queries!
Property _references_graph Undocumented

Inherited from BaseDatabaseOperations (via BaseSpatialOperations, DatabaseOperations):

Method __init__ Undocumented
Method adapt_datefield_value Transform a date value to an object compatible with what is expected by the backend driver for date columns.
Method adapt_decimalfield_value Transform a decimal.Decimal value to an object compatible with what is expected by the backend driver for decimal (numeric) columns.
Method adapt_ipaddressfield_value Transform a string representation of an IP address into the expected type for the backend driver.
Method adapt_unknown_value Transform a value to something compatible with the backend driver.
Method autoinc_sql Return any SQL needed to support auto-incrementing primary keys, or None if no SQL is necessary.
Method binary_placeholder_sql Some backends require special syntax to insert binary content (MySQL for example uses '_binary %s').
Method cache_key_culling_sql Return an SQL query that retrieves the first cache key greater than the n smallest.
Method compiler Return the SQLCompiler class corresponding to the given name, in the namespace corresponding to the `compiler_module` attribute on this backend.
Method conditional_expression_supported_in_where_clause Return True, if the conditional expression is supported in the WHERE clause.
Method convert_durationfield_value Undocumented
Method deferrable_sql Return the SQL to make a constraint "initially deferred" during a CREATE TABLE statement.
Method distinct_sql Return an SQL DISTINCT clause which removes duplicate rows from the result set. If any fields are given, only check the given fields for duplicates.
Method end_transaction_sql Return the SQL statement required to end a transaction.
Method execute_sql_flush Execute a list of SQL statements to flush the database.
Method explain_query_prefix Undocumented
Method fetch_returned_insert_columns Given a cursor object that has just performed an INSERT...RETURNING statement into a table, return the newly created data.
Method field_cast_sql Given a column type (e.g. 'BLOB', 'VARCHAR') and an internal type (e.g. 'GenericIPAddressField'), return the SQL to cast it before using it in a WHERE statement. The resulting string should contain a '%s' placeholder for the column being searched against.
Method for_update_sql Return the FOR UPDATE SQL clause to lock rows for an update operation.
Method force_no_ordering Return a list used in the "ORDER BY" clause to force no ordering at all. Return an empty list to include nothing in the ordering.
Method last_insert_id Given a cursor object that has just performed an INSERT statement into a table that has an auto-incrementing ID, return the newly created ID.
Method limit_offset_sql Return LIMIT/OFFSET SQL clause.
Method lookup_cast Return the string to use in a query when performing lookups ("contains", "like", etc.). It should contain a '%s' placeholder for the column being searched against.
Method max_in_list_size Return the maximum number of items that can be passed in a single 'IN' list condition, or None if the backend does not impose a limit.
Method max_name_length Return the maximum length of table and column names, or None if there is no limit.
Method modify_insert_params Allow modification of insert parameters. Needed for Oracle Spatial backend due to #10888.
Method prep_for_like_query Prepare a value for use in a LIKE query.
Method prepare_sql_script Take an SQL script that may contain multiple lines and return a list of statements to feed to successive cursor.execute() calls.
Method process_clob Return the value of a CLOB column, for backends that return a locator object that requires additional processing.
Method regex_lookup Return the string to use in a query when performing regular expression lookups (using "regex" or "iregex"). It should contain a '%s' placeholder for the column being searched against.
Method savepoint_commit_sql Return the SQL for committing the given savepoint.
Method savepoint_create_sql Return the SQL for starting a new savepoint. Only required if the "uses_savepoints" feature is True. The "sid" parameter is a string for the savepoint id.
Method savepoint_rollback_sql Return the SQL for rolling back the given savepoint.
Method sequence_reset_sql Return a list of the SQL statements required to reset sequences for the given models.
Method set_time_zone_sql Return the SQL that will set the connection's time zone.
Method start_transaction_sql Return the SQL statement required to start a transaction.
Method tablespace_sql Return the SQL that will be used in a query to define the tablespace.
Method unification_cast_sql Given a field instance, return the SQL that casts the result of a union to that type. The resulting string should contain a '%s' placeholder for the expression being cast.
Method validate_autopk_value Certain backends do not accept some values for "serial" fields (for example zero in MySQL). Raise a ValueError if the value is invalid, otherwise return the validated value.
Method window_frame_end Undocumented
Method window_frame_range_start_end Undocumented
Method window_frame_rows_start_end Return SQL for start and end points in an OVER clause window frame.
Method window_frame_start Undocumented
Method year_lookup_bounds_for_date_field Return a two-elements list with the lower and upper bound to be used with a BETWEEN operator to query a DateField value using a year lookup.
Method year_lookup_bounds_for_datetime_field Return a two-elements list with the lower and upper bound to be used with a BETWEEN operator to query a DateTimeField value using a year lookup.
Constant CURRENT_ROW Undocumented
Constant FOLLOWING Undocumented
Constant PRECEDING Undocumented
Constant UNBOUNDED_FOLLOWING Undocumented
Constant UNBOUNDED_PRECEDING Undocumented
Class Variable compiler_module Undocumented
Class Variable integer_field_ranges Undocumented
Class Variable set_operators Undocumented
Instance Variable connection Undocumented
Method _get_limit_offset_params Undocumented
Instance Variable _cache Undocumented
def convert_extent(self, box): (source)
overrides django.contrib.gis.db.backends.base.operations.BaseSpatialOperations.convert_extent

Convert the polygon data received from SpatiaLite to min/max values.

def geo_db_type(self, f): (source)
overrides django.contrib.gis.db.backends.base.operations.BaseSpatialOperations.geo_db_type

Return None because geometry columns are added via the `AddGeometryColumn` stored procedure on SpatiaLite.

def geom_lib_version(self): (source)

Return the version of the version-dependant geom library used by SpatiaLite.

def geometry_columns(self): (source)
overrides django.contrib.gis.db.backends.base.operations.BaseSpatialOperations.geometry_columns

Undocumented

def geos_version(self): (source)

Return the version of GEOS used by SpatiaLite as a string.

def get_distance(self, f, value, lookup_type): (source)
overrides django.contrib.gis.db.backends.base.operations.BaseSpatialOperations.get_distance

Return the distance parameters for the given geometry field, lookup value, and lookup type.

def get_geometry_converter(self, expression): (source)
overrides django.contrib.gis.db.backends.base.operations.BaseSpatialOperations.get_geometry_converter

Undocumented

def lwgeom_version(self): (source)

Return the version of LWGEOM library used by SpatiaLite.

def proj_version(self): (source)

Return the version of the PROJ library used by SpatiaLite.

def rttopo_version(self): (source)

Return the version of RTTOPO library used by SpatiaLite.

def spatial_aggregate_name(self, agg_name): (source)
overrides django.contrib.gis.db.backends.base.operations.BaseSpatialOperations.spatial_aggregate_name

Return the spatial aggregate SQL template and function for the given Aggregate instance.

def spatial_ref_sys(self): (source)
overrides django.contrib.gis.db.backends.base.operations.BaseSpatialOperations.spatial_ref_sys

Undocumented

def spatialite_version(self): (source)

Return the SpatiaLite library version as a string.

def spatialite_version_tuple(self): (source)

Return the SpatiaLite version as a tuple (version string, major, minor, subminor).

collect: str = (source)

Undocumented

disallowed_aggregates = (source)
overrides django.contrib.gis.db.backends.base.operations.BaseSpatialOperations.disallowed_aggregates

Undocumented

extent: str = (source)

Undocumented

from_text: str = (source)
overrides django.contrib.gis.db.backends.base.operations.BaseSpatialOperations.from_text

Undocumented

function_names: dict[str, str] = (source)
overrides django.contrib.gis.db.backends.base.operations.BaseSpatialOperations.function_names

Undocumented

gis_operators = (source)

Undocumented

makeline: str = (source)

Undocumented

name: str = (source)

Undocumented

select: str = (source)
overrides django.contrib.gis.db.backends.base.operations.BaseSpatialOperations.select

Undocumented

spatialite: bool = (source)
overrides django.contrib.gis.db.backends.base.operations.BaseSpatialOperations.spatialite

Undocumented

unionagg: str = (source)

Undocumented

@cached_property
spatial_version = (source)
overrides django.contrib.gis.db.backends.base.operations.BaseSpatialOperations.spatial_version

Determine the version of the SpatiaLite library.

@cached_property
unsupported_functions = (source)
overrides django.contrib.gis.db.backends.base.operations.BaseSpatialOperations.unsupported_functions

Undocumented

def _get_spatialite_func(self, func): (source)

Helper routine for calling SpatiaLite functions and returning their result. Any error occurring in this method should be handled by the caller.