Database write functions for librepcb::WorkspaceLibraryDb. More...

#include <workspacelibrarydbwriter.h>

Collaboration diagram for WorkspaceLibraryDbWriter:

Public Member Functions
	WorkspaceLibraryDbWriter ()=delete

	WorkspaceLibraryDbWriter (const WorkspaceLibraryDbWriter &other)=delete

	WorkspaceLibraryDbWriter (const FilePath &librariesRoot, SQLiteDatabase &db)

	~WorkspaceLibraryDbWriter () noexcept

void	createAllTables ()
	Create all tables to initialize the database.

void	addInternalData (const QString &key, int value)
	Add an integer value to the "internal" table.

int	addLibrary (const FilePath &fp, const Uuid &uuid, const Version &version, bool deprecated, const QByteArray &iconPng, const QString &manufacturer)
	Add a library.

void	updateLibrary (const FilePath &fp, const Uuid &uuid, const Version &version, bool deprecated, const QByteArray &iconPng, const QString &manufacturer)
	Update library metadata.

template<typename ElementType >
int	addElement (int libId, const FilePath &fp, const Uuid &uuid, const Version &version, bool deprecated, const QString &generatedBy)
	Add a library element.

template<typename ElementType >
int	addCategory (int libId, const FilePath &fp, const Uuid &uuid, const Version &version, bool deprecated, const std::optional< Uuid > &parent)
	addElement() specialized for categories

int	addDevice (int libId, const FilePath &fp, const Uuid &uuid, const Version &version, bool deprecated, const QString &generatedBy, const Uuid &component, const Uuid &package)
	addElement() specialized for devices

int	addPart (int devId, const QString &mpn, const QString &manufacturer)
	Add a part to a previously added device.

int	addPartAttribute (int partId, const Attribute &attribute)
	Add an attribute to a previously added part.

int	addOrganization (int libId, const FilePath &fp, const Uuid &uuid, const Version &version, bool deprecated, const QByteArray &logoPng, const QUrl &url, const QString &country, const QStringList &fabs, const QStringList &shipping, bool isSponsor, int priority)
	addElement() specialized for organizations

int	addOrganizationPcbDesignRules (int orgId, const Uuid &uuid, const QString &name, const QString &description, const QUrl &url, int maxLayers)
	Add PCB design rules to a previously added organization.

int	addOrganizationOutputJob (int orgId, WorkspaceLibraryDb::OutputJobKind kind, const Uuid &uuid, const QString &type, const QString &name)
	Add an output job to a previously added organization.

template<typename ElementType >
void	removeElement (const FilePath &fp)
	Remove a library element.

template<typename ElementType >
void	removeAllElements ()
	Remove all library elements of a specific type.

template<typename ElementType >
int	addTranslation (int elementId, const QString &locale, const std::optional< ElementName > &name, const std::optional< QString > &description, const std::optional< QString > &keywords)
	Add a translation for a library element.

template<typename ElementType >
void	removeAllTranslations ()
	Remove all translations for a library element type.

template<typename ElementType >
int	addToCategory (int elementId, const Uuid &category)
	Add a library element to a category.

template<typename ElementType >
int	addResource (int elementId, const QString &name, const QString &mediaType, const QUrl &url)
	Add a resource for a library element.

int	addAlternativeName (int pkgId, const ElementName &name, const SimpleString &reference)
	Add an alternative name to a previously added package.

WorkspaceLibraryDbWriter &	operator= (const WorkspaceLibraryDbWriter &rhs)=delete

Static Public Member Functions
template<typename ElementType >
static QString	getElementTable () noexcept
	Get the table name of an element type.

template<typename ElementType >
static QString	getCategoryTable () noexcept
	Get the category table name of an element type.

template<>
QString	getElementTable () noexcept

template<>
QString	getElementTable () noexcept

template<>
QString	getElementTable () noexcept

template<>
QString	getElementTable () noexcept

template<>
QString	getElementTable () noexcept

template<>
QString	getElementTable () noexcept

template<>
QString	getElementTable () noexcept

template<>
QString	getElementTable () noexcept

template<>
QString	getCategoryTable () noexcept

template<>
QString	getCategoryTable () noexcept

template<>
QString	getCategoryTable () noexcept

template<>
QString	getCategoryTable () noexcept

Private Member Functions
int	addElement (const QString &elementsTable, int libId, const FilePath &fp, const Uuid &uuid, const Version &version, bool deprecated, const QString &generatedBy)

int	addCategory (const QString &categoriesTable, int libId, const FilePath &fp, const Uuid &uuid, const Version &version, bool deprecated, const std::optional< Uuid > &parent)

void	removeElement (const QString &elementsTable, const FilePath &fp)

void	removeAllElements (const QString &elementsTable)

int	addTranslation (const QString &elementsTable, int elementId, const QString &locale, const std::optional< ElementName > &name, const std::optional< QString > &description, const std::optional< QString > &keywords)

void	removeAllTranslations (const QString &elementsTable)

int	addToCategory (const QString &elementsTable, int elementId, const Uuid &category)

int	addResource (const QString &elementsTable, int elementId, const QString &name, const QString &mediaType, const QUrl &url)

QString	filePathToString (const FilePath &fp) const noexcept

Static Private Member Functions
static QString	nonEmptyOrNull (const QString &s) noexcept

static QString	nonNull (const QString &s) noexcept

Private Attributes
FilePath	mLibrariesRoot

SQLiteDatabase &	mDb

Detailed Description

Database write functions for librepcb::WorkspaceLibraryDb.

Constructor & Destructor Documentation

◆ WorkspaceLibraryDbWriter() [1/3]

WorkspaceLibraryDbWriter ( )

delete

◆ WorkspaceLibraryDbWriter() [2/3]

WorkspaceLibraryDbWriter ( const WorkspaceLibraryDbWriter & other )

delete

◆ WorkspaceLibraryDbWriter() [3/3]

WorkspaceLibraryDbWriter	(	const FilePath &	librariesRoot,
		SQLiteDatabase &	db
	)

◆ ~WorkspaceLibraryDbWriter()

~WorkspaceLibraryDbWriter ( )

noexcept

Member Function Documentation

◆ createAllTables()

void createAllTables ( )

Create all tables to initialize the database.

This has to be done only once, after creating a new database.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addInternalData()

void addInternalData	(	const QString &	key,
		int	value
	)

Add an integer value to the "internal" table.

Parameters

key	The key to add.
value	The value to add.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addLibrary()

int addLibrary	(	const FilePath &	fp,
		const Uuid &	uuid,
		const Version &	version,
		bool	deprecated,
		const QByteArray &	iconPng,
		const QString &	manufacturer
	)

Add a library.

Parameters

fp	Filepath of the library.
uuid	UUID of the library.
version	Version of the library.
deprecated	Whether the library is deprecated or not.
iconPng	Icon as a PNG.
manufacturer	Name of the manufacturer of this library (optional).

Returns: ID of the added library.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateLibrary()

void updateLibrary	(	const FilePath &	fp,
		const Uuid &	uuid,
		const Version &	version,
		bool	deprecated,
		const QByteArray &	iconPng,
		const QString &	manufacturer
	)

Update library metadata.

Parameters

fp	Filepath of the library to update.
uuid	New UUID of the library.
version	New version of the library.
deprecated	Whether the library is deprecated or not.
iconPng	New icon as a PNG.
manufacturer	Name of the manufacturer of this library (optional).

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addElement() [1/2]

template<typename ElementType >

int addElement	(	int	libId,
		const FilePath &	fp,
		const Uuid &	uuid,
		const Version &	version,
		bool	deprecated,
		const QString &	generatedBy
	)

inline

Add a library element.

Template Parameters

ElementType Type of element to add.

Parameters

libId	ID of the library containing this element.
fp	Filepath of the element.
uuid	UUID of the element.
version	Version of the element.
deprecated	Whether the element is deprecated or not.
generatedBy	The generator name if generated or imported.

Returns: ID of the added element.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addCategory() [1/2]

template<typename ElementType >

int addCategory	(	int	libId,
		const FilePath &	fp,
		const Uuid &	uuid,
		const Version &	version,
		bool	deprecated,
		const std::optional< Uuid > &	parent
	)

inline

addElement() specialized for categories

Template Parameters

ElementType Type of category to add.

Parameters

libId	ID of the library containing this category.
fp	Filepath of the category.
uuid	UUID of the category.
version	Version of the category.
deprecated	Whether the category is deprecated or not.
parent	Parent of the category.

Returns: ID of the added category.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addDevice()

int addDevice	(	int	libId,
		const FilePath &	fp,
		const Uuid &	uuid,
		const Version &	version,
		bool	deprecated,
		const QString &	generatedBy,
		const Uuid &	component,
		const Uuid &	package
	)

addElement() specialized for devices

Parameters

libId	ID of the library containing this device.
fp	Filepath of the device.
uuid	UUID of the device.
version	Version of the device.
deprecated	Whether the device is deprecated or not.
generatedBy	The generator name if generated or imported.
component	Component UUID of the device.
package	Package UUID of the device.

Returns: ID of the added device.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addPart()

int addPart	(	int	devId,
		const QString &	mpn,
		const QString &	manufacturer
	)

Add a part to a previously added device.

Parameters

devId	ID of the device containing this part.
mpn	Manufacturer part number.
manufacturer	Manufacturer name.

Returns: ID of the added part.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addPartAttribute()

int addPartAttribute	(	int	partId,
		const Attribute &	attribute
	)

Add an attribute to a previously added part.

Parameters

partId	ID of the part containing this attribute.
attribute	Attribute to add.

Returns: ID of the added attribute.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addOrganization()

int addOrganization	(	int	libId,
		const FilePath &	fp,
		const Uuid &	uuid,
		const Version &	version,
		bool	deprecated,
		const QByteArray &	logoPng,
		const QUrl &	url,
		const QString &	country,
		const QStringList &	fabs,
		const QStringList &	shipping,
		bool	isSponsor,
		int	priority
	)

addElement() specialized for organizations

Parameters

libId	ID of the library containing this organization.
fp	Filepath of the organization.
uuid	UUID of the organization.
version	Version of the organization.
deprecated	Whether the organization is deprecated or not.
logoPng	Logo as a PNG.
url	Website URL.
country	Country code (e.g. "DE").
fabs	Country codes of fabs (e.g. "DE").
shipping	Shipping options (e.g. "worldwide").
isSponsor	Is LibrePCB sponsor or not.
priority	Sort order priority.

Returns: ID of the added organization.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addOrganizationPcbDesignRules()

int addOrganizationPcbDesignRules	(	int	orgId,
		const Uuid &	uuid,
		const QString &	name,
		const QString &	description,
		const QUrl &	url,
		int	maxLayers
	)

Add PCB design rules to a previously added organization.

Parameters

orgId	ID of the organization containing this design rules.
uuid	Design rules UUID.
name	Design rules name.
description	Design rules description.
url	Design rules URL.
maxLayers	Maximum number of layers.

Returns: ID of the added design rules.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addOrganizationOutputJob()

int addOrganizationOutputJob	(	int	orgId,
		WorkspaceLibraryDb::OutputJobKind	kind,
		const Uuid &	uuid,
		const QString &	type,
		const QString &	name
	)

Add an output job to a previously added organization.

Parameters

orgId	ID of the organization containing this output job.
kind	Kind of output job.
uuid	Job UUID.
type	Job type (e.g. "gerber_excellon").
name	Job name.

Returns: ID of the added output job.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeElement() [1/2]

template<typename ElementType >

void removeElement ( const FilePath & fp )

inline

Remove a library element.

Note: This will automatically remove its translations and categories as well.

Template Parameters

ElementType Type of element to remove.

Parameters

fp	Filepath of the element to remove.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeAllElements() [1/2]

template<typename ElementType >

void removeAllElements ( )

inline

Remove all library elements of a specific type.

Note: This will automatically remove their translations and categories as well.

Template Parameters

ElementType Type of elements to remove.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addTranslation() [1/2]

template<typename ElementType >

int addTranslation	(	int	elementId,
		const QString &	locale,
		const std::optional< ElementName > &	name,
		const std::optional< QString > &	description,
		const std::optional< QString > &	keywords
	)

inline

Add a translation for a library element.

Template Parameters

ElementType Type of element to add translations.

Parameters

elementId	ID of the element to add translations.
locale	Locale of the translations.
name	Element name.
description	Eleemnt description.
keywords	Element keywords.

Returns: ID of the added translation.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeAllTranslations() [1/2]

template<typename ElementType >

void removeAllTranslations ( )

inline

Remove all translations for a library element type.

Template Parameters

ElementType Type of element to remove translationss.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addToCategory() [1/2]

template<typename ElementType >

int addToCategory	(	int	elementId,
		const Uuid &	category
	)

inline

Add a library element to a category.

Template Parameters

ElementType Type of element to add to the category.

Parameters

elementId	ID of the element to add to the category.
category	Category UUID.

Returns: ID of the added category.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addResource() [1/2]

template<typename ElementType >

int addResource	(	int	elementId,
		const QString &	name,
		const QString &	mediaType,
		const QUrl &	url
	)

inline

Add a resource for a library element.

Template Parameters

ElementType Type of element of the resource.

Parameters

elementId	ID of the element of the resource.
name	Resource name
mediaType	Resource media type.
url	Resource URL.

Returns: ID of the added resource.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addAlternativeName()

int addAlternativeName	(	int	pkgId,
		const ElementName &	name,
		const SimpleString &	reference
	)

Add an alternative name to a previously added package.

Parameters

pkgId	ID of the package for this alternative name.
name	Alternative name (mandatory).
reference	Origin of the alternative name (optional).

Returns: ID of the added part.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getElementTable() [1/9]

template<typename ElementType >

static QString getElementTable ( )

staticnoexcept

Get the table name of an element type.

Template Parameters

ElementType Type of element to get the table name of.

Returns: Table name (e.g. "symbols" for librepcb::Symbol).

◆ getCategoryTable() [1/5]

template<typename ElementType >

static QString getCategoryTable ( )

staticnoexcept

Get the category table name of an element type.

Template Parameters

ElementType Type of element to get the category table name of.

Returns: Category table name (e.g. "component_categories" for librepcb::Symbol).

◆ operator=()

WorkspaceLibraryDbWriter & operator= ( const WorkspaceLibraryDbWriter & rhs )

delete

◆ addElement() [2/2]

int addElement	(	const QString &	elementsTable,
		int	libId,
		const FilePath &	fp,
		const Uuid &	uuid,
		const Version &	version,
		bool	deprecated,
		const QString &	generatedBy
	)

private

Here is the call graph for this function:

◆ addCategory() [2/2]

int addCategory	(	const QString &	categoriesTable,
		int	libId,
		const FilePath &	fp,
		const Uuid &	uuid,
		const Version &	version,
		bool	deprecated,
		const std::optional< Uuid > &	parent
	)

private

Here is the call graph for this function:

◆ removeElement() [2/2]

void removeElement	(	const QString &	elementsTable,
		const FilePath &	fp
	)

private

Here is the call graph for this function:

◆ removeAllElements() [2/2]

void removeAllElements ( const QString & elementsTable )

private

Here is the call graph for this function:

◆ addTranslation() [2/2]

int addTranslation	(	const QString &	elementsTable,
		int	elementId,
		const QString &	locale,
		const std::optional< ElementName > &	name,
		const std::optional< QString > &	description,
		const std::optional< QString > &	keywords
	)

private

Here is the call graph for this function:

◆ removeAllTranslations() [2/2]

void removeAllTranslations ( const QString & elementsTable )

private

Here is the call graph for this function:

◆ addToCategory() [2/2]

int addToCategory	(	const QString &	elementsTable,
		int	elementId,
		const Uuid &	category
	)

private

Here is the call graph for this function:

◆ addResource() [2/2]

int addResource	(	const QString &	elementsTable,
		int	elementId,
		const QString &	name,
		const QString &	mediaType,
		const QUrl &	url
	)

private

Here is the call graph for this function:

◆ filePathToString()

QString filePathToString ( const FilePath & fp ) const

privatenoexcept

Here is the caller graph for this function:

◆ nonEmptyOrNull()

QString nonEmptyOrNull ( const QString & s )

staticprivatenoexcept

Here is the caller graph for this function:

◆ nonNull()

QString nonNull ( const QString & s )

staticprivatenoexcept

Here is the caller graph for this function:

◆ getElementTable() [2/9]

template<>

QString getElementTable ( )

staticnoexcept

◆ getElementTable() [3/9]

template<>

QString getElementTable ( )

staticnoexcept

◆ getElementTable() [4/9]

template<>

QString getElementTable ( )

staticnoexcept

◆ getElementTable() [5/9]

template<>

QString getElementTable ( )

staticnoexcept

◆ getElementTable() [6/9]

template<>

QString getElementTable ( )

staticnoexcept

◆ getElementTable() [7/9]

template<>

QString getElementTable ( )

staticnoexcept

◆ getElementTable() [8/9]

template<>

QString getElementTable ( )

staticnoexcept

◆ getElementTable() [9/9]

template<>

QString getElementTable ( )

staticnoexcept

◆ getCategoryTable() [2/5]

template<>

QString getCategoryTable ( )

staticnoexcept

◆ getCategoryTable() [3/5]

template<>

QString getCategoryTable ( )

staticnoexcept

◆ getCategoryTable() [4/5]

template<>

QString getCategoryTable ( )

staticnoexcept

◆ getCategoryTable() [5/5]

template<>

QString getCategoryTable ( )

staticnoexcept

Member Data Documentation

◆ mLibrariesRoot

FilePath mLibrariesRoot

private

◆ mDb

SQLiteDatabase& mDb

private

The documentation for this class was generated from the following files:

/__w/1/s/libs/librepcb/core/workspace/workspacelibrarydbwriter.h
/__w/1/s/libs/librepcb/core/workspace/workspacelibrarydbwriter.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ WorkspaceLibraryDbWriter() [1/3]

◆ WorkspaceLibraryDbWriter() [2/3]

◆ WorkspaceLibraryDbWriter() [3/3]

◆ ~WorkspaceLibraryDbWriter()

Member Function Documentation

◆ createAllTables()

◆ addInternalData()

◆ addLibrary()

◆ updateLibrary()

◆ addElement() [1/2]

◆ addCategory() [1/2]

◆ addDevice()

◆ addPart()

◆ addPartAttribute()

◆ addOrganization()

◆ addOrganizationPcbDesignRules()

◆ addOrganizationOutputJob()

◆ removeElement() [1/2]

◆ removeAllElements() [1/2]

◆ addTranslation() [1/2]

◆ removeAllTranslations() [1/2]

◆ addToCategory() [1/2]

◆ addResource() [1/2]

◆ addAlternativeName()

◆ getElementTable() [1/9]

◆ getCategoryTable() [1/5]

◆ operator=()

◆ addElement() [2/2]

◆ addCategory() [2/2]

◆ removeElement() [2/2]

◆ removeAllElements() [2/2]

◆ addTranslation() [2/2]

◆ removeAllTranslations() [2/2]

◆ addToCategory() [2/2]

◆ addResource() [2/2]

◆ filePathToString()

◆ nonEmptyOrNull()

◆ nonNull()

◆ getElementTable() [2/9]

◆ getElementTable() [3/9]

◆ getElementTable() [4/9]

◆ getElementTable() [5/9]

◆ getElementTable() [6/9]

◆ getElementTable() [7/9]

◆ getElementTable() [8/9]

◆ getElementTable() [9/9]

◆ getCategoryTable() [2/5]

◆ getCategoryTable() [3/5]

◆ getCategoryTable() [4/5]

◆ getCategoryTable() [5/5]

Member Data Documentation

◆ mLibrariesRoot

◆ mDb