Skip to content

Latest commit

 

History

History
910 lines (692 loc) · 37.8 KB

CHANGELOG-FUNCTIONS.md

File metadata and controls

910 lines (692 loc) · 37.8 KB
Raw

Kinetica REST API Changelog

Version 7.2

Version 7.2.1.0

Non-breaking changes
  • Added hnsw to index_type option in /alter/table

Version 7.2.0.2 -- 2024-03-04

Changed Endpoints

  • Removed sm_omp_threads and kernel_omp_threads options from /alter/system/properties request
  • Added option show_worker_info to /admin/show/jobs endpoint
Non-breaking changes
  • Added cagra to index_type option in /alter/table
  • Added index_options option in /alter/table
  • Added refresh_index to action in /alter/table
  • Added query_text to /admin/show/jobs response

Version 7.2.0.0 -- 2024-02-11

Added

  • Added /export/query/metrics
  • Added the following endpoints to support write ahead logging
    • /alter/wal
    • /show/wal
    • /admin/repair/table
  • Added /admin/ha/refresh

Changed Endpoints

Non-breaking Changes
  • Added primary_key_type option to /create/table endpoint and /show/table response
  • Added chunk_column_max_memory option where chunk_size option is currently in various endpoints
  • Added chunk_max_memory option where chunk_size option is currently in various endpoints
  • Added evict_to_cold option to /alter/system/properties
  • Added array, json and vector to properties list in /create/type
Breaking Changes
  • A new endpoint /repartition/graph is added

Version 7.1

Version 7.1.10.0

Changed Endpoints

  • Added option allow_multiple_edges to /create/graph endpoint to allow a graph to have multiple edges between pairs of nodes; otherwise, duplicate edges are ignored
  • Added option allow_multiple_edges to /modify/graph endpoint to allow a graph to have multiple edges between pairs of nodes; otherwise, duplicate edges are ignored
  • Added option find_common_labels to /query/graph endpoint to list common labels between source & target nodes
  • Added option s3_verify_ssl to /create/datasink and /create/datasource endpoints to disable SSL verification

Version 7.1.9.0

  • Added value 'gdb' to file_type option in external files endpoints (insert_records_from_files, create_table_external)

Changed Endpoints

  • Added option dependencies to /show/table endpoint to list the DDLs of the dependencies of a view
  • Added options POINTCOLOR_ATTR & SHAPEFILLCOLOR_ATTR to /wms endpoint
  • Renamed /alter/system/properties option kafka_timeout to kafka_poll_timeout
  • Added new Louvain clustering algorithm solver type match_clusters and related options to /match/graph
  • Added option query_parameters to /execute/sql endpoint, allowing data to be passed in JSON format
  • Added option offset to /create/projection endpoint
  • Added options refresh_span and refresh_stop_time to /create/materializedview endpoint
  • Added options set_refresh_stop_time and set_refresh_span to /alter/table endpoint
  • Added additional_info map item execute_stop_time to response for endpoint /show/sql/proc
  • Added additional_info map item refresh_stop_time to response for endpoint /show/table
  • Added options compression_type, truncate_strings, & max_records_to_load to endpoints capable of loading data from files:
    • /create/table/external
    • /insert/records/fromfiles
    • /insert/records/frompayload
  • Added optionsremote_query_increasing_column & subscribe for remote table/query subscriptions via JDBC data sources
  • Added 'file_names' to response for endpoint /delete/files. Added wildcard support to KiFS endpoints:
    • /show/files
    • /download/files
    • /delete/files
  • Added /admin/ha/refresh
  • Added evict_to_cold option to /alter/system/properties
  • Added options execute_at_startup and execute_at_startup_as to /execute/proc endpoint to facilitate running procs (UDFs) on startup
  • Added option clear_execute_at_startup to /kill/proc endpoint to remove a startup proc (UDF) instance
  • Added option verify_orphaned_tables_only to /admin/verifydb endpoint
  • Added 'orphaned_tables_total_size' to response for endpoint /admin/verifydb
  • Added new action rebuild to /alter/environment
  • Added option show_current_user to /show/security endpoint
  • Added option show_worker_info to /admin/show/jobs endpoint

Added

  • Added new endpoints to support UDF python environment management:
    • /alter/environment
    • /create/environment
    • /drop/environment
    • /show/environment
  • Added option set_environment to /create/proc endpoint

Version 7.1.8.7

Added

  • Added ignore_existing_pk option to all endpoints that accept update_on_existing_pk

Version 7.1.8.0

Added

  • Added new endpoint /export/records/tofiles
  • Added new endpoint /alter/directory

Changed Endpoints

  • Added new options resource_group and default_schema to /create/user/external endpoint
  • Added new option directory_data_limit to /create/user/internal and /create/user/external endpoints
  • Added new option data_limit to /create/directory endpoint
  • Added new options jdbc_session_init_statement, jdbc_connection_init_statement, remote_table, use_st_geomfrom_casts, use_indexed_parameters to /export/records/totable endpoint
  • Added new options jdbc_session_init_statement, remote_query_order_by, num_splits_per_rank to /insert/records/fromquery endpoint
Non-breaking Changes
  • Added support for Azure, HDFS, S3 and Google Cloud storage providers to /create/datasink and /alter/datasink endpoints
  • Added rank option to /alter/tier
  • Added delete_orphaned_tables option to /admin/verify_db
Breaking Changes

Version 7.1.7.0

Added

  • Added support for Google Cloud Storage as a backend for cold storage and external data sources
  • Added new endpoint /insert/records/fromquery
  • Added new endpoint /export/records/totable
  • Added new endpoint /upload/files/fromurl

Changed Endpoints

  • Added new options gcs_bucket_name, gcs_project_id and gcs_service_account_keys to endpoints /create/datasource and /alter/datasource
  • Added new options gcs_service_account_id and gcs_service_account_keys to endpoints /create/credential and /alter/credential
  • Added new options jdbc_driver_jar_path and jdbc_driver_class_name to endpoints /create/datasource and /create/datasink
  • Added new options remote_query and remote_query_filter_column to /create/table/external endpoint
  • Added new options tcs_per_tom, tps_per_tom, and max_concurrent_kernels to /alter/system/properties endpoint
  • Added new option expression to /get/records/fromcollection endpoint
  • Added new options create_temp_table, result_table, result_table_persist, and ttl to endpoint /aggregate/k_means
  • Added new info item qualified_result_table_item to response for endpoint /aggregate/k_means
  • Added new solve method and its options, match_charging_stations for endpoint /match/graph/
  • Added new internal option simplify to /create/graph and /modify/graph endpoints
  • Added new options track_id_column_name and track_order_column_name to /visualize/image and /visualize/image/classbreak
Breaking Changes
  • Added new option persist to endpoints /alter/system/properties, /alter/resourcegroup, and /alter/tier, which defaults to true

Version 7.1.6.0 -- 2022-01-27

Added

  • Added new endpoint /repartition/graph
  • Added new endpoint /show/resource/objects
  • Existing option bad_record_table_limit was per rank and now global in endpoints:
    • /create/table/external
    • /insert/records/fromfiles
    • /insert/records/frompayload
  • Added option bad_record_table_limit_per_input, limiting bad records to insert into bad_record_table_name when inserting from subscription or from multiple files, to endpoints:
    • /create/table/external
    • /insert/records/fromfiles
    • /insert/records/frompayload

Changed Endpoints

Non-breaking Changes
  • Added new option create_home_directory to /create/user/internal, /create/user/external, and /create/directory endpoints
  • Added table_monitor as a valid object type to /has/permission, /grant/permission and /revoke/permission endpoints
  • Added new option create_temp_table to the following endpoints:
    • /aggregate/groupby
    • /aggregate/unique
    • /aggregate/unpivot
    • /create/jointable
    • /create/projection
    • /create/table
    • /create/union
    • /filter
    • /filter/byarea
    • /filter/byarea/geometry
    • /filter/bybox
    • /filter/bybox/geometry
    • /filter/bygeometry
    • /filter/bylist
    • /filter/byradius
    • /filter/byradius/geometry
    • /filter/byrange
    • /filter/byseries
    • /filter/bystring
    • /filter/bytable
    • /filter/byvalue
    • /merge/records
  • Added action type stop_deployment to /alter/model endpoint
  • Added deployments details to /show/model response
  • Added owner_resource_group details to /show/table response
  • Added graph_owner_resource_groups to /show/graph response
  • Added data field resource group entries of /show/resource/statistics response
  • Added action type change_owner to the following endpoints:
    • /alter/table
  • Added option cascade_delete to /delete/resource/group endpoint
  • Added new option max_data option to the following:
    • /alter/resource/group request
    • /create/resource/group request
    • /show/resource/groups response
    • Added option show_tier_usage to /show/resource/groups endpoint
    • /show/resource/groups allows any user to query their group(s).
    • Added option skip_lines to external tables endpoints: /insert/records/fromfiles, /insert/records/frompayload, /create/table/external
  • Added new option use_managed_credentials to the following endpoints:
    • /create/datasource
    • /alter/datasource
  • Added internal option create_metadata to /alter/system/properties endpoint
  • Added internal option get_auto_view_updators to /alter/system/properties endpoint
Breaking Changes
  • Creation of named non-persistent tables now requires table_admin permission on the parent schema, as with persistent tables. Users without table_admin permission on any schema may use the new option create_temp_table for a system-generated table name that does not require table_admin permission.
  • Changed delete_resource_group to return an error if there are users associated with that group or if there are any tables or graphs owned by the group.
  • Changed show_resource_groups
    • Request will return an error if the user requests a group which does not exist, previously returned the default group.
    • Changed default value of option show_default_group to be false if an explicit list of group names is provided. Previously was always true.

Version 7.1.5.0 -- 2021-10-13

Added

  • Added the following endpoints to support data sinks:

    • /alter/datasink
    • /create/datasink
    • /drop/datasink
    • /grant/permission
    • /has/role
    • /revoke/permission
    • /show/datasink

  • Added new endpoints for table monitors:

    • /show/tablemonitors

Changed Endpoints

  • Added new options increasing_column and expression to /create/tablemonitor endpoint.
  • Added new options monitor_id, datasink_name, destination and kafka_topic_name to /create/tablemonitor endpoint.
  • Added new permission types connect_datasink and connect_datasource to /has/permission endpoint.
  • Added new table monitor subscription event type all to create a monitor id for all events
Non-breaking Changes
  • Added shadow_cube_replacement_policy option to /alter/system/properties endpoint
  • Added audit_response option to /alter/system/properties endpoint
  • Added new file type: avro in external files endpoints
Breaking Changes
  • Fields in the /has/permission were changed to match /grant/permission.

Version 7.1.4.0 -- 2021-07-29

Added Endpoints

  • Added the following endpoints to support video:

    • /alter/video
    • /create/video
    • /get/video
    • /show/video

  • Added the following endpoints to support the KiFS global file namespace:

    • /create/directory
    • /delete/directory
    • /delete/files
    • /download/files
    • /grant/permission/directory
    • /revoke/permission/directory
    • /show/directories
    • /show/files
    • /upload/files

  • New endpoints to support database backup:

    • /admin/backup/begin
    • /admin/backup/end

  • Other new endpoints:

    • /has/permission

Changed Endpoints

Non-breaking Changes
  • Added new options to /alter/system/properties
    • kafka_batch_size
    • kafka_wait_time
    • kafka_timeout
  • Added new actions to /alter/table
    • cancel_datasource_subscription
    • pause_datasource_subscription
    • resume_datasource_subscription
  • Removed kafka_group_id option from /create/datasource
  • Added kafka_group_id option to
    • /create/table/external
    • /insert/records/fromfiles
  • Added datasource_subscriptions additional info option to /show/table response
  • Added a new option inverse_solve for the match_batch_solves solver of /match/graph.
  • Added a new solve method match_loops for /match/graph with two additional options:
    • min_loop_level
    • max_loop_level
  • Added new /match/graph options for match_loops solve to improve performance:
    • output_batch_size
    • search_limit
  • The /match/graph endpoint has a new option added for MSDO solver option. The new opton name is max_truck_stops. If specified (greater than zero), a truck can at most have this many stops (demand locations) in one round trip. Otherwise, it is unlimited. If enable_truck_reuse is on, this condition will be applied separately at each round trip use of the same truck.
  • Added two solvers to the /solve/graph endpoint:
    • STATS_ALL
    • CLOSENESS (for centrality)
  • Added new /solve/graph options for page_rank solve to improve performance:
    • convergence_limit
    • max_iterations
  • Changed default type_inference_mode to speed - for 3 external files endpoints: /create/table/external, /insert/records/fromfiles, & /insert/records/frompayload
  • New options to /create/table/external, /insert/records/fromfiles, & /insert/records/frompayload: text_search_columns & text_search_min_column_length.
  • /create/table/external, /insert/records/fromfile new option: table_insert_mode with valid_choices: table_per_file, single (default 0)
  • /create/table/external, /insert/records/fromfile and /insert/records/frompayload new value for option: file_type:shapefile
  • Added max_output_lines option to /execute/proc to limit captured stdout and stderr output
Breaking Changes
  • /solve/graph internal option for distributed solves
  • /show/graph added info about partitioned graphs as well as graph memory
  • /admin/show/jobs Added flags field to response to provide additional job metadata
  • /show/proc/status added output field to response to return captured stdout and stderr output

Version 7.1.3.0 -- 2021-03-05

Added Endpoints

  • Added the following endpoints to support credentials:
    • /alter/credential
    • /create/credential
    • /drop/credential
    • /show/credential
    • /grant/permission/credential
    • /revoke/permission/credential

Changed Endpoints

Non-breaking Changes
  • Added a new credential option to the following endpoints:
    • /create/datasource
    • /alter/datasource

Version 7.1.2.0 -- 2021-01-25

Changed Endpoints

Non-breaking Changes
  • The output_tracks option is added for the /match/graph solver match_supply_demand for timestamped tracks generation directly and accurately.
  • All graph endpoints except for /delete/graph and /modify/graph can now to a server_id as an option.
  • /admin/reblance & /admin/remove/ranks option aggressiveness defaults to 10
  • Added execute_as option to /create/materializedview and /alter/table endpoints.
  • /create/table/external, /insert/records/fromfile and /insert/records/frompayload new option: type_inference_mode with valid_choices: accuracy, speed
  • /create/table/external, /insert/records/fromfile and /insert/records/frompayload new option: max_records_to_load (default=0: load all)
  • /create/table/external, /insert/records/fromfile and /insert/records/frompayload new option: store_points_as_xy and store_points_as_xyz (both have same meaning)
Breaking Changes
  • Multiple graph servers support:
    • /create/graph and /modify/graph response now has a result field indicating success on all graph servers.
    • /show/graph
      • Response now provide info about which graph server each graph is on.
      • Will also provide some extra info about each server (CPU load and memory)
    • /show/system/properties graph parameters are now vectorized and prefixed with graph.
    • /show/system status replaced graph_status by vector of graph status similar to ranks.
  • /admin/add/ranks, /admin/remove/ranks, and /admin/rebalance now require the database to be offline

Version 7.1.1.0 -- 2020-11-05

Changed Endpoints

Non-breaking Changes
  • /create/type
    • Added uuid as a new column property.
    • Added init_with_uuid as a new column property for uuid column.
  • /create/table endpoint: added SERIES to the valid_choices for the partition_type

Version 7.1.0.0 -- 2020-08-18

Added Endpoints

  • Added the following endpoints to support cluster resiliency:
    • /admin/add/host
    • /admin/alter/host
    • /admin/remove/host
    • /admin/switchover
  • Added the following endpoints to support SQL schemas:
    • /create/schema
    • /alter/schema
    • /drop/schema
    • /show/schema
    • /has/schema
  • Added the following endpoints to support data source:
    • /create/datasource
    • /alter/datasource
    • /drop/datasource
    • /show/datasource
    • /grant/permission/datasource
    • /revoke/permission/datasource

Changed Endpoints

Non-breaking Changes

  • Deprecated collection_name parameters wherever they appear. The new method is to qualify the table name or set the default schema.

  • Added qualified_table_name to the response info map for the following endpoints:

    • /create/materializedview
    • /create/table
    • /create/union
    • /merge/records

  • Added qualified_projection_name to the response info map for the following endpoints:

    • /create/projection

  • Added qualified_result_table_name to the response info map for the following endpoints:

    • /aggregate/groupby
    • /aggregate/unique
    • /aggregate/unpivot

  • Added qualified_table_name to the response info map for the following endpoints:

    • /filter
    • /filter/byarea
    • /filter/byarea/geometry
    • /filter/bybox
    • /filter/bybox/geometry
    • /filter/bygeometry
    • /filter/bylist
    • /filter/byradius
    • /filter/byradius/geometry
    • /filter/byrange
    • /filter/byseries
    • /filter/bystring
    • /filter/bytable
    • /filter/byvalue

  • /admin/rebalance

    • Renamed option table_whitelist to include_tables
    • Renamed option table_blacklist to exclude_tables

  • /alter/system/properties

    • Removed enable_compound_equi_join as an option

  • /alter/user

    • Added set_default_schema as an action

  • /alter/table

    • Added move_to_schema as an action

  • /show/table

    • Added schema_name to additional_info map
    • Added the following table_descriptions: LOGICAL_VIEW, LOGICAL_EXTERNAL_TABLE, MATERIALIZED_EXTERNAL_TABLE, & SCHEMA

  • Added cb_pointalphas option and cb_pointalpha_attrs and cb_pointalpha_vals fields to /visualize/image/classbreak to support manipulation of transparency in class-break visualization.

Breaking Changes
  • /admin/add/ranks
    • changed added_ranks parameter in response to an array of strings
    • removed results parameter from response
  • /admin/remove/ranks
    • changed ranks parameter in request to an array of strings
    • changed removed_ranks parameter in response to an array of strings
    • removed results parameter from response

Version 7.0

Version 7.0.21.0 - TBD

Changed Endpoints

Non-breaking Changes
  • xxx
Breaking Changes
  • xxx

Version 7.0.20.0 - 2020-11-18

Changed Endpoints

Non-breaking Changes
  • Added execute_as additional_info map key to /show/sql/proc response.

Version 7.0.19.0 - 2020-08-24

Changed Endpoints

Non-breaking Changes
  • Added 'output_edge_path' (default=false) and 'output_wkt_path' (default=true) options for turning on and off ability to export out aggregated path lists columns onto the solution table for the path solvers of /solve/graph endpoint for more speed.
  • /create/table endpoint: added "SERIES" to the valid_choices for the partition_type

Version 7.0.18.0 - 2020-07-30

Changed Endpoints

Non-breaking Changes
  • Added cb_pointalphas option and cb_pointalpha_attrs and cb_pointalpha_vals fields to visualize/image/classbreak to support manipulation of transparency in class-break visualization.
Breaking Changes

Version 7.0.17.0 - 2020-07-06

Non-breaking Changes
  • Added a job_tag option to the following endpoints:
    • /create/job
    • /get/job
    • /admin/alter/job
  • Added a job_tag field to /show/job

Changed Endpoints

  • /match/graph option 'enable_truck_reuse' added for supply demand solver of /match/graph for reusing truck in multiple rounds from the same originating depot
  • /match/graph option 'truck_service_limit' added for sypply demand solver of /match/graph as an additional constraint on the total cost of any truck's delivery route.
  • /match/graph option 'max_num_threads" added for multi-core support for many trips map matching. If specified it will not be exceeded but it can be lower due to memory and number of core threads availibility.
  • /match/graph solve_method 'incremental_weighted' is removed as it was defunc.
  • /match/graph option 'unit_unloading_cost' added for match_supply_demand_solver type to add unloading time to the optimization.
  • /match/graph option 'filter_folding_paths' added for the markov_chain solver type to filter out the folding paths for more accurate results.
  • /match/graph option 'max_trip_cost' added for match_supply_demand solver type to restrict trips between stops excedding this number except from/to the origin.
  • /solve/graph option 'accurate_snaps' added.
  • /match/graph for solve type 'match_supply_demand' only: the option 'aggregated_output' (default: true) added
  • /create/graph, /modify/graph: newly added option of 'add_turns' (default: false), 'turn_angle' (default: 60)
  • /solve/graph, /match/graph: newly added options of 'left_turn_penaly', 'right_turn_penalty', 'intersection_penalty', 'sharp_turn_penalty' (default: 0.0)
  • /solve/graph Added 'output_edge_path' (default=false) and 'output_wkt_path' (default=true) options for turning on and off ability to export out aggregated path lists columns onto the solutioon table for the path solvers of /solve/graph endpoint for more speed.
Breaking Changes
Non-breaking Changes
  • Added datasource_name option to /create/external/table and /insert/records/from/files

Version 7.0.16.0 - TBD

Changed Endpoints

Non-breaking Changes
  • Added 'unit_unloading_cost' option is added to the /match/graph endpoint for match_supply_demand solve case to add the unloading time per drop amount.
  • Added total_number_of_records and has_more_records to /get/records/fromcollection response info map.
Breaking Changes

Version 7.0.12.0 - 2020-1-10

Non-breaking Changes
  • Added "count" to the info map in the responses for create_projection, create_union and execute_sql.

Version 7.0.11.0 - 2019-12-10

Added Endpoints

  • Added a new endpoint /insert/records/fromfiles to insert records from external files into a new or existing table.
  • Added a new endpoint /modify/graph for updates of an existing graph in a non-streaming fashion.

Changed Endpoints

Non-breaking Changes
  • Added an option remove_label_only to create and modify graph endpoints (see option's doc)
  • Added enable_overlapped_equi_join and enable_compound_equi_join options to /alter/system/properties
  • Added columns and sql_where options to /grant/permission/table

Version 7.0.10.0 - 2019-11-13

Changed Endpoints

Breaking Changes
  • Add additional_info map to /show/sql/proc to list attributes of sql procedures.
Non-breaking Changes

  • Added allpaths solve graph option to solve for all the paths between source and destination. It is recommended to run this with the options of max and min solution radiua set carefully. The min value should be greater than or equal to the shortest path cost and it is further advised to set the max_number_targets option to limit the resulting paths.

  • Added modify create graph option. When recreate and modify is both true for an existing graph it'll update the graph instead of deleting and recreating it.

  • Added match_batch_solves solver type valid choice to the /match/graph endpoint's solve_method parameter. This solver is strictly for WKTPOINT source and destination pairs with an ID and runs as many shortest paths as there are unique source and destination pairs provided as efficiently as possible. This change was made to bridge the gap for the shortest_path solver in batch mode only for WKTPOINT node types in /solve/graph because it is not possible to match the ID of the pair in the solution_table.

  • Added execute_interval and execute_start_time to the /show/sql/proc.

  • Added default values for parameters offset and limit to the following endpoints:

    • /aggregate/groupby
    • /aggregate/unique
    • /execute/sql
    • /get/records/bycolumn

  • Changed default limit from 10k to -9999 (END_OF_SET) for the following endpoints:

    • /aggregate/groupby
    • /aggregate/unique
    • /execute/sql
    • /get/records/bycolumn
    • /get/records/fromcollection
    • /get/records

  • Added "compact_after_rebalance", "compact_only", and "repair_incorrectly_sharded_data" options to /admin/rebalance

Version 7.0.9.0 - 2019-10-16

Added Endpoints

  • Added new /show/sql/proc endpoint to show SQL Procedure definitions

Changed Endpoints

Breaking Changes
  • Updated the /solve/graph/ endpoint to remove clunky and obscure primary parameters:
    • Removed source_node, source_node_id, destination_node_ids, and node_type parameters
    • Added source_nodes parameter as vector of strings that is of NODE component type. For backwards compatibility, one of the following could be passed to both source_nodes and destination_nodes:
      • ["{'POINT(10 10)'} AS NODE_WKTPOINT"]
      • ["POINT(10 10)"]
      • ["table.column AS NODE_WKTPOINT"]
  • In the case of backhaul_routing solver type, the fixed assets are now placed in source_nodes and the remote assets are placed in destination_nodes instead of having all assets being placed in destination_nodes and the number of fixed assets being placed in source_node_id
Non-breaking Changes
  • Added bad_record_indices and error_N info map keys to /insert/records response
  • Added evict_columns option to /alter/system/properties
  • Added return_individual_errors, allow_partial_batch, and dry_run options to /insert/records
  • Added retain_partitions option to /create/projection. This option will cause the projection to be created with the same partition scheme as the source table, if possible. In prior versions, this was the default behavior but we are now making it optional and turned off by default.
  • Added a max_combinations option to /match/graph for match_supply_demand solver type
  • Added index_type option to /alter/table. This option affects the create_index and delete_index actions and can have a value of column (the default) or chunk_skip. Setting the option to column will create/delete a standard attribute index while the value of chunk_skip will create/delete a chunk-skip index, which is useful in cases where there are large numbers of chunks (i.e. due to partitioning).

Version 7.0.8.0 - 2019-09-18

Changed Endpoints

Non-breaking Changes
  • Added truncate_strings option to /update/records

Version 7.0.7.0 - 2019-08-15

Changed Endpoints

Non-breaking Changes
  • Added match_supply_demand solver type valid choice to the /match/graph endpoint's solve_method parameter
  • Added partial_loading option to /match/graph
  • Added support for the ulong (unsigned long) property within the string type to /create/type

Version 7.0.6.0 - 2019-07-11

Added Endpoints

  • Added internal /show/graph/grammar endpoint to be consumed by GAdmin

  • Added internal /alter/graph endpoint to enable cancelling graph jobs

  • Added the following endpoints to support proc (UDF) execute permissions:

    • /grant/permission/proc
    • /revoke/permission/proc

  • Added /show/graph to show basic properties of one or all graphs on the graph server

Changed Endpoints

Breaking Changes
  • Moved rings option to a top-level parameter in /query/graph
Non-breaking Changes
  • Added aggressiveness option to /admin/rebalance and /admin/remove/ranks
  • Added show_async_jobs option to /admin/show/jobs to enable showing completed async jobs as they are no longer shown by default

Version 7.0.5.0 - 2019-06-25

Changed Endpoints

  • Aligned /visualize/isochrone options parameter with the contour_options and solve_options parameters
  • Added use_priority_queue_solvers option to /visualize/isochrone to accelerate solve times for small to medium underlying graphs

Version 7.0.4.0 - 2019-06-05

Version 7.0.3.0 - 2019-05-01

Version 7.0.2.0 - 2019-04-10

Version 7.0.1.0 - 2019-03-01

Version 7.0.0.0 - 2018-06-28

Added Endpoints

  • Added the following endpoints for resource management:

    • /create/resourcegroup
    • /show/resourcegroups
    • /alter/resourcegroup
    • /delete/resourcegroup
    • /alter/tier

Changed Endpoints

Breaking Changes
  • Updated /create/user/internal to handle resource group names
Non-breaking Changes
  • Added info string-to-string map to the responses of all endpoints. This map will contain additional information that may vary from endpoint to endpoint
  • Updated /show/security response to include resource group names
  • Updated /create/user/internal response to handle resource group names

Version 6.2

Version 6.2.0.0 - 2018-02-11

Added Endpoints

  • Added the following endpoints to submit synchronously running jobs and retrieve the results of the job:
    • /create/job
    • /get/job
  • Added /create/materializedview endpoint

Changed Endpoints

Non-breaking Changes
  • Added max_concurrency_per_node option to /create/proc

Version 6.1

Version 6.1.0.0 - 2018-01-08

Added Endpoints

  • Added the following geometry-specific endpoints:

    • /aggregate/minmax/geometry
    • /filter/byarea/geometry
    • /filter/bybox/geometry
    • /filter/byradius/geometry

Changed Endpoints

Breaking Changes
  • The following endpoints no longer support operations on geometry columns:
    • /aggregate/minmax
    • /filter/byarea
    • /filter/bybox
    • /filter/byradius
Non-breaking Changes
  • Added support for the wkt property within the string type to /create/type
  • Added support for column names other than "WKT" to /filter/bygeometry

Version 6.0

Version 6.0.0.0 - 2017-01-24

Added Endpoints

  • Added /has/proc endpoint to support external procs

Changed Endpoints

Breaking Changes
  • Moved execution_mode option to a top-level parameter in /create/proc
  • Modified /execute/proc
  • Shuffled /create/projection parameter order
Non-breaking Changes
  • Added timings to the /show/proc response
  • The following supported values have been added to action in /alter/table:
    • add_column
    • delete_column
    • change_column
    • rename_table
  • The following options have been added to /alter/table:
    • column_default_value
    • column_properties
    • column_type
    • validate_change_column
    • copy_values_from_column
    • rename_column
  • Added support for the following properties to /create/type:
    • decimal (base type string)
    • date (base type string)
    • time (base type string)
  • The following supported values have been added to mode in /create/union:
    • union_all (default)
    • union
    • union_distinct
    • except
    • intersect
  • The following options have been added to /create/projection:
    • expression
    • limit

Version 5.4

Version 5.4.0.0 - 2016-11-30

Added Endpoints

  • Added /create/projection endpoint for selecting a subset of columns (including derived columns) from a table into a new result table with optional sorting
  • Added the following external proc support endpoints:
    • /create/proc
    • /delete/proc
    • /execute/proc (replaces Node.js-exclusive version)
    • /kill/proc
    • /show/proc
    • /show/proc/status

Changed Endpoints

Non-breaking Changes
  • Null values for nullable columns are now supported in /update/records

Version 5.2

Version 5.2.0.0 - 2016-09-21

Added Endpoints

  • Added the following security system endpoints:
    • /alter/user
    • /create/role
    • /create/user/external
    • /create/user/internal
    • /delete/role
    • /delete/user
    • /grant/permission/system
    • /grant/permission/table
    • /grant/role
    • /revoke/permission/system
    • /revoke/permission/table
    • /revoke/role
    • /show/security
  • Added the /create/union endpoint

Changed Endpoints

Breaking Changes
  • /alter/table/properties merged into /alter/table
  • /show/table/properties merged into /show/table
  • /visualize/image/heatmap has additional style options and a simplified schema
Non-breaking Changes
  • /get/records now shows if there are more records to retrieve
  • Added percentile to the list of supported values for stats in /aggregate/statistics
  • Added support for changing the maximum request timeout time to /alter/system/properties
  • Added not_in_list to the list of supported values for the filter_mode option in /filter/bylist to enable inverse matching
  • Added result_table option to /aggregate/groupby
  • Added support for arg_min, arg_max, and count_distinct aggregates to /aggregate/groupby
  • Added result_table option to /aggregate/unique

Version 5.1

Version 5.1.0.0 - 2016-05-06

Changed Endpoints

Non-breaking Changes
  • Added having option to /aggregate/groupby

Version 4.2

Version 4.2.0.0 - 2016-04-11

Changed Endpoints

Breaking Changes
  • Refactor schemas and integrate documentation into JSON schemas