...

...

 DBEntry

Class structure:

Class keeps information about one, particular  database entry (eg. pulse-file, HDC container, SQL-database, etc etc)

• db_entryDBEntry class represents data accessible through Access Layer 
• hdc_entryHDCEntry , sql_entrySQLEntry  are examples of classes that represents IMAS data entry accessible via other mechanisms than AL (if they will be implemented in future)
• imas_entryIMASEntry a parent class for all ??_entryall XXXEntry classes. It will be implemented in future if any other mechanism of accessing data than AL will be used. Could be empty...  

...

• backend_id - MDSPLUS_BACKEND, MEMORY_BACKEND, ASCII_BACKEND - mandatory -   
• db name - eg. test   - mandatory 
• shot - mandatory
• run - mandatory
• user name - eg. g2bpalak  -  optional - if None → $USER  optional  (if None  → $USER)
• data version - e.g. 3 - optional - currently not used,  we should keep it as it will point us to a proper dir in imasdb structure, when we develop versions 4,5, etc  - if None → 3None → $IMAS_VERSION 

def __init__(self, backend_id, db_name, shot, run, user_name = None, data_version = 3None)
	if userNameuser_name is None:
		user_name = $USER

	if data_version is None:
		data_version = $IMAS_VERSION

Additional "URI-based" constructor will be added in future...

...

All parameters that defines db_entryDBEntry  are set in constructor, so create, open, close will have no mandatory arguments

def create(self, options = None)
def open(self, options = None)
def close(self, options = None)

options - additional options (possibly backend specific)

DBEntry methods for IDS storing /reading

Get IDS

...

Code Block
language py title IDS GET
def get(self, idsNameids_name, occurrence = 0) # idsNameids_name (e.g. 'equilibrium', IDSName.EQUILIBRIUM, wall.__name__ (see below)) return ids

Put IDS

...

Code Block
language py title IDS PUT
def put(self, ids, occurrence = 0)

IDS

...

put slice

def put_slice(self, ids, occurrence = 0)

IDS

...

get slice 

def get_slice(self, ids_name, time_requested, interpolation_method, occurrence=0): # idsName (e.g. 'equilibrium')
	return ids

Any other method is needed to ba added to db_entry class?

...

Partial Get

def partial_get(self, ids_name, data_path, occurrence = 0, db_entry = None):

IDS superclass

IDSBase  - Parent class for all classes representing particular IDSes. 

Class  methods (aka "static")

def get_ids(cls, ids_name):

. For internal use only - it should not be called by users.

IDS class

Class  methods (aka "static")

IDS storing / reading

db_entry  is used to provide explicitly context to methodsTo provide database context user has to pass explicitly DBEntry object to all methods responsible for saving / reading data. This parameter should be mandatory, but is  but has to be kept optional to keep ensure backward compatibility....

def put(self, occurrence=0, db_entry=None):

def get(self, occurrence=0, db_entry=None):

def putSlice(self, occurrence=0, db_entry=None):

def getSlice(self, time_requested, interpolation_method, occurrence=0, db_entry=None):

def partialGet(self, dataPath, occurrence=0, db_entry = None):

...

"Messy" methods

... that are not in line with proposed design but they must be kept to ensure backward compatibility.

def copy_valuessetPulseCtx(self, ids):

def delete_data(self, occurrence=0, db_entry=None ):

def partial_get(self, dataPath, occurrence=0, db_entry=None):

def get_field(self, dataPath, occurrence=0, db_entry=None):

"Messy" methods

... that are not in line with proposed design but they must be kept to ensure backward compatibility.

 ctx):
def getPulseCtx(self):

Examples

Backward compatibility

  import imas

  imasEnv = imas.ids(1111, 1111)
  imasEnv.create_env(user, db_name, dd_version)  
    
  # Mandatory property
  imasEnv.pf_active.ids_properties.homogeneous_time = 2

  imasEnv.pf_active.put()
        
  imasEnv.close()

import imas

imasEnv = imas.ids(1111, 1111)
imasEnv.open_env(user, db_name, dd_version)  




imasEnv.pf_active.get()
  
imasEnv.close()

Storing/reading data via db_entry methods

import imas
from imas import imasdef

db_entry = imas.DBEntry(imasdef.MDSPLUS_BACKEND, db_name, 2222, 2222)
db_entry.create()  
    
ids = imas.pf_active()
# Mandatory property
ids.ids_properties.homogeneous_time = 2

db_entry.put(ids)

db_entry.close()

import imas
from imas import imasdef

db_entry = imas.DBEntry(imasdef.MDSPLUS_BACKEND, db_name, 2222, 2222)
db_entry.open()  





ids = db_entry.get('pf_active')

db_entry.close()

Storing/reading data via ids methods

import imas
from imas import imasdef

db_entry = imas.DBEntry(imasdef.MDSPLUS_BACKEND, db_name, 3333, 3333)
db_entry.create()  
    
ids = imas.pf_active()
ids.ids_properties.homogeneous_time = 2

ids.put(db_entry = db_entry)
db_entry.close()

import imas
from imas import imasdef

db_entry = imas.DBEntry(imasdef.MDSPLUS_BACKEND, db_name, 3333, 3333)
db_entry.create()  

ids = imas.pf_active()


ids.get(db_entry = db_entry)
db_entry.close()