Collection (p.shakuhachi.0.3.0.doc.shakuhachi.libs.Skhclibs.Collection)

Sourcetype t

type of a collection

Sourceval open' : SkhcConfig.Config.t -> t

open' config opens the collection with configuration provided by config.

Sourceval realpath : t -> string -> string

realpath collection path returns

path if path is absolute (eg. starts with / on unix).
music_directory + path if path is relative.

val database : 
  ?mode:[ `NO_CREATE | `READONLY ] ->
  ?uri:bool ->
  ?memory:bool ->
  ?mutex:[ `FULL | `NO ] ->
  ?cache:[ `PRIVATE | `SHARED ] ->
  ?vfs:string ->
  t ->
  SkhcDb.Database.t

database collection returns a database handler associated with collection.

see Sqlite3.db_open for details of all optional arguments.

before 0.3.0,
no mode, uri, memory, mutex, cache, vfs optional arguments.

Source

val with_database : 
  ?mode:[ `NO_CREATE | `READONLY ] ->
  ?uri:bool ->
  ?memory:bool ->
  ?mutex:[ `FULL | `NO ] ->
  ?cache:[ `PRIVATE | `SHARED ] ->
  ?vfs:string ->
  t ->
  (SkhcDb.Database.t -> 'a) ->
  'a

with_database collection f runs f with a database handler associated with collection. SkhcDb.Database.close is guaranteed to be called whether f completes normaly or raises an exception. with_database discards any results or exceptions of SkhcDb.Database.close.

see Sqlite3.db_open for details of all optional arguments.

before 0.3.0,
no mode, uri, memory, mutex, cache, vfs optional arguments.

Sourceval config : t -> SkhcConfig.Config.t

config collection returns the configuration used when calling open'.

Sourceval dir_artist : t -> SkhcMetadata.Metadata.t -> string

dir_artist collection metadata returns the directory name of where should be collected the artist's albums according to metadata. The path returned is relative to configuration's music_directory.

Sourceval dir_artist_absolute : t -> SkhcMetadata.Metadata.t -> string

dir_artist_absolute collection metadata is dir_artist but returns the absolute path instead of the relative one.

Sourceval dir_album : t -> SkhcMetadata.Metadata.t -> string

dir_album collection metadata returns the directory name of where should be collected the album's songs according to metadata. The path returned is relative to configuration's music_directory. Since shakuhachi stores songs in a artist/album directory structure, this function calls dir_artist underneath.

Sourceval dir_album_absolute : t -> SkhcMetadata.Metadata.t -> string

dir_album_absolute collection metadata is dir_album but returns the absolute path instead of the relative one.

Sourcemodule Album : sig ... end

Operations on albums

Sourcemodule Artist : sig ... end

Operations on artists

Sourcemodule Music : sig ... end

Operations on musics

Sourcemodule Playlist : sig ... end

Operations on playlists