Populate Class Reference

Static Public Member Functions
_.Library.Integer	Populate (_.Library.Integer count, _.Library.Integer verbose, _.Library.Integer DeferIndices, _.Library.Integer objects, _.Library.Integer tune, _.Library.Integer deterministic)
	Creates up to count instances an object and stores. More...
_.Library.String	PopulateSerial ()
	Create a single instance of a serial object.

Static Public Attributes
	POPSPEC = None
	POPSPEC defines a 'value generator method' for a property. More...

Detailed Description

For details on using this class, see Using the Populate Utility.

<CLASS>Populate</CLASS> is a utility class that provides the ability to create instances of an object populated with random data.

To use the <CLASS>Populate</CLASS> class do the following:

1. Create a persistent object class, such as Employee.

2. Add <CLASS>Populate</CLASS> to the end of the class' superclass list:
   

   super = Persistent,Populate

Save and compile the class. <CLASS>Populate</CLASS> will add a class method, Populate(), to your class. Run this method to create instances of your class in the database:

Do ##class(Employee).Populate(100)

Constructor & Destructor Documentation

Populate()

_.Library.Integer Populate ( _.Library.Integer  count, _.Library.Integer  verbose, _.Library.Integer  DeferIndices, _.Library.Integer  objects, _.Library.Integer  tune, _.Library.Integer  deterministic  )

static

Creates up to count instances an object and stores.

them in the database.

If verbose is true, then details are echoed to the console.

If DeferIndices is true, then indices are sorted at the end of the operation.

If objects is true, then each object that is created is returned in the objects array

If tune is true, then $SYSTEM.SQL.TuneTable is called after the instances of the class have been created. If tune>1, then $SYSTEM.SQL.TuneTable is also called for any tables projected by persistent superclasses of this class

If deterministic is true, then the set of objects produced by identical calls to Populate at different times will be identical.

Returns the number of instances successfully created.

For details, see Using the Populate Utility.

Member Data Documentation

POPSPEC

POPSPEC = None

static

POPSPEC defines a 'value generator method' for a property.

The POPSPEC parameter provides a way to control how.

It is used by the Populate class to generate sample data. The format of POPSPEC is this

[:[<collection count>]:[<collection array key value generator>]].

For details on using this class, see Using the Populate Utility.

<CLASS>Populate</CLASS> is a utility class that provides the ability to create instances of an object populated with random data.

To use the <CLASS>Populate</CLASS> class do the following:

1. Create a persistent object class, such as Employee.

2. Add <CLASS>Populate</CLASS> to the end of the class' superclass list:
   

   super = Persistent,Populate

Save and compile the class. <CLASS>Populate</CLASS> will add a class method, Populate(), to your class. Run this method to create instances of your class in the database:

Do ##class(Employee).Populate(100)

<CLASS>Populate</CLASS> generates data for properties.

For details, see Using the Populate Utility.