LocalObject

LocalObject[]

represents a new anonymous local object.

LocalObject["file:///"]

represents a local object with a given file path.

LocalObject["relpath"]

represents a local object with the given relative path.

LocalObject["relpath","lbase"]

represents a local object relative to the base lbase.

Details

  • Relative paths are resolved with respect to $LocalBase.
  • LocalObject[File["path"]] and LocalObject[relpath,File["path"]] are also supported.
  • DeleteObject[LocalObject[]] removes a local object.
  • LocalObject[]["property"] gives the value of the specified property for the given local object.
  • Properties of local objects include:
  • "URL"the absolute file: URL of the local object
    "Type"the type of information stored in the local object
    "ObjectFile"the absolute path of the metadata file
    "DataFile"the absolute path of the data file
  • LocalObject[]["Properties"] gives the list of all supported properties of the given local object.
  • LocalObject[][All] gives an association of propertyvalue pairs for all properties of the given local object.

Examples

open allclose all

Basic Examples  (3)

An unnamed local object:

A named local object in the user's local base directory:

A named local object in a subdirectory of the user's local base directory:

Remove a local object:

Scope  (8)

Local objects can be used with Put and Get to store expressions persistently:

Local objects can be used with Export and Import to store data persistently:

Local objects can be used with CopyFile to store files persistently:

Import the file stored in the local object:

Local objects can be used with Save to save definitions persistently:

Definitions saved can be read into the Wolfram Language using Get:

Local objects can be used with DumpSave to save definitions persistently:

Clear definitions for f:

Restore the definitions for f from the local object:

Local objects can be deleted with DeleteObject:

Local objects can be listed with LocalObjects:

Create a local object:

Display information about the local object:

Give the list of all known properties:

Give the value of a specific property:

Give an association of all property-value pairs:

Generalizations & Extensions  (3)

Local objects can be created in any file:

File paths can also be specified with File:

The base for resolving relative paths can be given as the second argument:

The base can be taken from another local object:

Applications  (1)

Delete all existing local objects:

Properties & Relations  (9)

Relative paths are resolved with respect to $LocalBase:

Local symbols are local objects stored in the directory $LocalSymbolBase:

A file scheme URL can be converted to a path by ExpandFileName:

A local object can be given directly in ExpandFileName:

File scheme URLs and local objects can be used in FileNameSplit:

CloudObject provides for persistent storage in the cloud:

Find all local objects used as caches:

RenameFile works on local objects:

FileNameJoin works with local objects:

Possible Issues  (2)

Applying LocalObject by itself does not create the referenced file:

Only by writing content is it actually created:

Most properties are undefined for nonexistant objects:

Wolfram Research (2015), LocalObject, Wolfram Language function, https://reference.wolfram.com/language/ref/LocalObject.html.

Text

Wolfram Research (2015), LocalObject, Wolfram Language function, https://reference.wolfram.com/language/ref/LocalObject.html.

CMS

Wolfram Language. 2015. "LocalObject." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/LocalObject.html.

APA

Wolfram Language. (2015). LocalObject. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/LocalObject.html

BibTeX

@misc{reference.wolfram_2023_localobject, author="Wolfram Research", title="{LocalObject}", year="2015", howpublished="\url{https://reference.wolfram.com/language/ref/LocalObject.html}", note=[Accessed: 29-March-2024 ]}

BibLaTeX

@online{reference.wolfram_2023_localobject, organization={Wolfram Research}, title={LocalObject}, year={2015}, url={https://reference.wolfram.com/language/ref/LocalObject.html}, note=[Accessed: 29-March-2024 ]}