Ispyb

~~~~~~~~~~~~~~~~~~

New methods:

* ``retrieve_sessions_for_beamline_and_run``, `75 <https://github.com/DiamondLightSource/ispyb-api/pull/75>`_
* ``retrieve_data_collection_group``, `81 <https://github.com/DiamondLightSource/ispyb-api/pull/81>`_

~~~~~~~~~~~~~~~~~~

Added more fields to the `datacollection object model <https://ispyb.readthedocs.io/en/latest/api.html#module-ispyb.model.datacollection>`_.

~~~~~~~~~~~~~~~~~~

Breaking changes:

* configuration file section ``ispyb_mysql_sp`` renamed to ``ispyb_mariadb_sp``
* mxprocessing: ``upsert_program`` has been removed. Use ``upsert_program_ex`` instead.
* processing interface: removed ``get_processing_job``

Future breaking changes:

* Exception classes renamed and moved from ``ispyb.exception`` into ``ispyb``.
Using previous exception classes will generate deprecation warnings.

New features:

* Authorisation built into the queries for relevant stored procedures

* New methods for:

* storing x-ray centring results
* retrieving persons on a session
* un-assigning all containers on a certain beamline

* New reconnection parameters in config file: ``reconn_attempts`` and ``reconn_delay``
* ``update_container_assign`` now returns the containerId and the new containerStatus


How to prepare a release

First, ensure that you have updated `HISTORY.rst` with the changes for the new release and committed the changes.

To prepare an ISPyB API release you need to install the package [bump-my-version](https://github.com/callowayproject/bump-my-version):

bash
pip install bump-my-version


and then, in the repository directory, run one of the following

bash

-------------------

Roles and permissions: Granted ``SELECT``, ``INSERT``, ``UPDATE`` on ``ProcessedTomogram``
for ``ispyb_processing``

-------------------

Roles and permissions: grants files for new ispyb expeye roles

New or modified tables, columns, lookup values:

- New table ``ProcessedTomogram``
- New rows for 'VMXm-Cartridge' and 'VMXm-Cartridge' in the ``ContainerType`` table
- New FK column ``ownerId`` (references ``Person.personId``) in the ``BLSampleGroup`` table
- New 'Metal ID' enum item in ``DiffractionPlan.experimentKind``
- New 'Metal ID' enum item in ``DataCollectionGroup.experimentType``
- New row for 'Metal ID' (for MX) in ``ExperimentType`` table

Stored procedures: ``upsert_dc_group_v3`` now populates ``DataCollectionGroup.experimentTypeId`` based on ``p_experimenttype``

New script to perform LVM snapshot-based backup

-------------------

New or modified tables and columns:

- New table ``Atlas``
- New table ``GridSquare``
- New Table ``FoilHole``
- In table ``Movie``: New columns ``foilHoleId`` and ``templateLabel``
- In table ``Shipping``: New column ``source`` and ``externalShippingIdToSynchrotron``
- In table ``Dewar``: New column ``source`` and ``externalShippingIdFromSynchrotron``
- In table ``Container``: New column ``source``
- In table ``BLSample``: New column ``source``
- In table ``AutoProcProgramMessage``: Make column ``severity`` not nullable
- In table ``ContainerQueue``: Make column ``containerId`` not nullable

Indexes:

- In table ``BLSubSample``: Replace ``blSampleId`` FK index with compound index ``(blSampleId, source)``
- In table ``ProcessingJobParameter``: Add compund index (parameterKey, processingJobId)
- In table ``AutoProc``: Remove ``spaceGroup`` from compound index ``(refinedCell_a, refinedCell_b, refinedCell_c, refinedCell_alpha, refinedCell_beta, refinedCell_gamma)``

Roles and permissions:

- Granted SELECT, INSERT, UPDATE on ``BFactorFit``, ``Atlas``, ``GridSquare``, ``FoilHole`` for ``ispyb_processing``
- Added new role ``ispyb_propagation`` and granted SELECT, UPDATE, INSERT, DELETE on relevant tables