def add_many(self, database_entries, ignore_already_added=False):
"""Add a row of database entries "at once". If this method is used,
only one entry is saved in the undo history.
Parameters
----------
database_entries : iterable of sunpy.database.tables.DatabaseEntry
The database entries that will be added to the database.
ignore_already_added : bool, optional
See Database.add
"""
cmds = CompositeOperation()
for database_entry in database_entries:
# use list(self) instead of simply self because __contains__ checks
# for existence in the database and not only all attributes except
# ID.
if database_entry in list(self) and not ignore_already_added:
raise EntryAlreadyAddedError(database_entry)
cmd = commands.AddEntry(self.session, database_entry)
if self._enable_history:
cmds.add(cmd)
else:
cmd()
if database_entry.id is None:
self._cache.append(database_entry)
else:
self._cache[database_entry.id] = database_entry
if cmds:
self._command_manager.do(cmds)
def add(self, database_entry, ignore_already_added=False):
"""Add the given database entry to the database table.
Parameters
----------
database_entry : sunpy.database.tables.DatabaseEntry
The database entry that will be added to this database.
ignore_already_added : bool, optional
If True, attempts to add an already existing database entry will
result in a :exc:`sunpy.database.EntryAlreadyAddedError`.
Otherwise, a new entry will be added and there will be duplicates
in the database.
"""
if database_entry in self and not ignore_already_added:
raise EntryAlreadyAddedError(database_entry)
add_entry_cmd = commands.AddEntry(self.session, database_entry)
if self._enable_history:
self._command_manager.do(add_entry_cmd)
else:
add_entry_cmd()
if database_entry.id is None:
self._cache.append(database_entry)
else:
self._cache[database_entry.id] = database_entry
def add_from_dir(self,
path,
recursive=False,
pattern='*',
ignore_already_added=False,
time_string_parse_format=None):
"""
Search the given directory for FITS files and use their FITS headers
to add new entries to the database. Note that one entry in the database
is assigned to a list of FITS headers, so not the number of FITS headers
but the number of FITS files which have been read determine the number
of database entries that will be added. FITS files are detected by
reading the content of each file, the ``pattern`` argument may be used to
avoid reading entire directories if one knows that all FITS files have
the same filename extension.
Parameters
----------
path : str
The directory where to look for FITS files.
recursive : bool, optional
If True, the given directory will be searched recursively.
Otherwise, only the given directory and no subdirectories are
searched. The default is `False`, i.e. the given directory is not
searched recursively.
pattern : str, optional
The pattern can be used to filter the list of filenames before the
files are attempted to be read. The default is to collect all
files. This value is passed to the function :func:`fnmatch.filter`,
see its documentation for more information on the supported syntax.
ignore_already_added : bool, optional
See :meth:`sunpy.database.Database.add`.
time_string_parse_format : str, optional
Fallback timestamp format which will be passed to
`~astropy.time.Time.strptime` if `sunpy.time.parse_time` is unable to
automatically read the ``date-obs`` metadata.
"""
cmds = CompositeOperation()
entries = tables.entries_from_dir(
path,
recursive,
pattern,
self.default_waveunit,
time_string_parse_format=time_string_parse_format)
for database_entry, filepath in entries:
if database_entry in list(self) and not ignore_already_added:
raise EntryAlreadyAddedError(database_entry)
cmd = commands.AddEntry(self.session, database_entry)
if self._enable_history:
cmds.add(cmd)
else:
cmd()
self._cache.append(database_entry)
if cmds:
self._command_manager.do(cmds)
