Database Models
=========================================

Deployment
----------------------

Attributes of the Deployment Dataclass

..  list-table::
    :header-rows: 1
    :widths: 20 20 60

    *   - Attribute
        - Type
        - Description

    *   - **name**
        - str (optional)
        - Optional name for a deployment.

    *   - **deployed_at**
        - Date
        - Date of the creation of a deployment.

    *   - **id**
        - int 
        - The id of a deployment.

    *   - **deployed_by**
        - str
        - The user_id that deployed this deployment.

   
=====

Device
--------------

Attributes of the Device Dataclass

..  list-table::
    :header-rows: 1
    :widths: 20 20 60

    *   - Attribute
        - Type
        - Description

    *   - **name**
        - str
        - The name of the device.

    *   - **num_qubits**
        - int
        - The amount of qubits available on this device.

    *   - **is_simulator**
        - int
        - Whether the device is a simulator (true) or not (false).

    *   - **is_local**
        - int
        - Whether jobs executed on this device are executed local or not.

    *   - **id**
        - int
        - The id of the device.

    *   - **provider_id**
        - int
        - provider_id of the provider saved in the provider table.



=====

Job
----------------------

Attributes of the Job Dataclass

..  list-table::
    :header-rows: 1
    :widths: 20 20 60

    *   - Attribute
        - Type
        - Description

    *   - **name**
        - str (optional)
        - Optional name for a job.

    *   - **executed_by**
        - str (optional)
        - A user_id associated to the job, user that wants to execute the job.

    *   - **progress**
        - float
        - The progress of the job.

    *   - **state**
        - str
        - The state of a job, enum JobState.

    *   - **shots**
        - int
        - The number of shots for the job.

    *   - **type**
        - JobType
        - The type of the job.

    *   - **started_at**
        - Date (optional)
        - The moment the job was scheduled. (default :py:func:`~datetime.datetime.utcnow`)

    *   - **id**
        - int
        - The id of a job.

    *   - **provider_specific_id**
        - str (optional)
        - The provider specific id for the job. (Used for canceling)

    *   - **celery_id**
        - str (optional)
        - The celery id for the job. (used for canceling)

    *   - **executed_on_id**
        - str 
        - The device_id of the device where the job is running on.

    *   - **deployment_id**
        - int 
        - A deployment_id associated with the job.

    *   - **finished_at**
        - Date (optional)
        - The moment the job finished successfully or with an error.

Provider
--------

Attributes of the Provider Dataclass

..  list-table::
    :header-rows: 1
    :widths: 20 20 60

    *   - Attribute
        - Type
        - Description

    *   - **name**
        - str
        - Name of the cloud service.

    *   - **with_token**
        - bool
        - If authentication is needed and can be done by passing a token this attribute is true.

    *   - **id**
        - int
        - The id of a provider.

=====

ProviderAssemblerLanguage
-----------------------------

Attributes of the ProviderAssemblerLanguage Dataclass

..  list-table::
    :header-rows: 1
    :widths: 20 20 60

    *   - Attribute
        - Type
        - Description

    *   - **supported_language**
        - str (enum)
        - The AssemblerLanguage (Enum) which is supported.

    *   - **id**
        - int
        - The ID of the assembler language.

    *   - **provider_id**
        - int
        - The ID of the provider that supports this language.

=====

QuantumProgram
-----------------

Attributes of the QuantumProgram Dataclass


..  list-table::
    :header-rows: 1
    :widths: 20 20 60

    *   - Attribute
        - Type
        - Description

    *   - **quantum_circuit**
        - str
        - Quantum code that will be executed.

    *   - **assembler_language**
        - str
        - Assembler language in which the code should be interpreted.

    *   - **id**
        - int
        - The ID of the quantum program.

    *   - **deployment_id**
        - int
        - The deployment where a list of quantum programs is used.

    *   - **python_file_path**
        - str
        - Part of experimental feature: path to file to be uploaded (to IBM).

    *   - **python_file_metadata**
        - str
        - Part of experimental feature: metadata for the python_file.

    *   - **python_file_options**
        - str
        - Part of experimental feature: options for the python_file.

    *   - **python_file_inputs**
        - str
        - Part of experimental feature: inputs for the python_file.

=====

Result
-----------------

Attributes of the Result Dataclass

..  list-table::
    :header-rows: 1
    :widths: 20 20 60

    *   - Attribute
        - Type
        - Description

    *   - **result_dict**
        - dict
        - The results of the job, in the given result_type.
          For the Runner it should have the keys counts and probabilities.
          The counts and probabilities should be a dict with hexadecimals as quantum-bit-keys.

    *   - **id**
        - int
        - The ID of the result.

    *   - **job_id**
        - int
        - The job_id that was executed.

    *   - **program_id**
        - int
        - the ID of the QuantumProgram that was executed

    *   - **meta_data**
        - int
        - Other data that was provided by the provider.

    *   - **result_type**
        - enum
        - Result type depending on the Job_Type of the job.

=====