org.squeryl

Schema

trait Schema extends AnyRef

linear super types: AnyRef, Any
known subclasses: StatsSchema
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Schema
  2. AnyRef
  3. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Type Members

  1. class ActiveRecord [A] extends AnyRef

    Active Record pattern implementation.

  2. class ColGroupDeclaration extends AnyRef

  3. class ReferentialActionImpl extends ReferentialAction

  4. class ReferentialEvent extends AnyRef

Value Members

  1. def != (arg0: AnyRef) : Boolean

    attributes: final
    definition classes: AnyRef
  2. def != (arg0: Any) : Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  3. def ## () : Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf [T0] () : T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf [T0] () : Boolean

    attributes: final
    definition classes: AnyRef
  6. def == (arg0: AnyRef) : Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  7. def == (arg0: Any) : Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  8. object NamingConventionTransforms extends AnyRef

  9. def afterDelete [A] ()(implicit m: Manifest[A]) : LifecycleEventPercursorClass[A]

    attributes: protected
  10. def afterDelete [A] (t: Table[A]) : LifecycleEventPercursorTable[A]

    attributes: protected
  11. def afterInsert [A] ()(implicit m: Manifest[A]) : LifecycleEventPercursorClass[A]

    attributes: protected
  12. def afterInsert [A] (t: Table[A]) : LifecycleEventPercursorTable[A]

    attributes: protected
  13. def afterUpdate [A] ()(implicit m: Manifest[A]) : LifecycleEventPercursorClass[A]

    attributes: protected
  14. def afterUpdate [A] (t: Table[A]) : LifecycleEventPercursorTable[A]

    attributes: protected
  15. implicit def anyRef2ActiveTransaction [A] (a: A)(implicit queryDsl: QueryDsl, m: Manifest[A]) : ActiveRecord[A]

    Creates a ActiveRecord instance for the given the object.

    Creates a ActiveRecord instance for the given the object. That allows the user to save the given object using the Active Record pattern.

    returns

    a instance of ActiveRecord associated to the given object.

    attributes: implicit
  16. def applyDefaultForeignKeyPolicy (foreignKeyDeclaration: ForeignKeyDeclaration) : Unit

  17. def asInstanceOf [T0] : T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  18. def autoIncremented (sequenceName: String) : AutoIncremented

    attributes: protected
  19. def autoIncremented : AutoIncremented

    attributes: protected
  20. def beforeDelete [K, A <: KeyedEntity[K]] ()(implicit m: Manifest[A]) : LifecycleEventPercursorClass[A]

    attributes: protected
  21. def beforeDelete [A] (t: Table[A])(implicit ev: <:<[A, org.squeryl.KeyedEntity[_]]) : LifecycleEventPercursorTable[A]

    attributes: protected
  22. def beforeInsert [A] ()(implicit m: Manifest[A]) : LifecycleEventPercursorClass[A]

    attributes: protected
  23. def beforeInsert [A] (t: Table[A]) : LifecycleEventPercursorTable[A]

    attributes: protected
  24. def beforeUpdate [A] ()(implicit m: Manifest[A]) : LifecycleEventPercursorClass[A]

    attributes: protected
  25. def beforeUpdate [A] (t: Table[A]) : LifecycleEventPercursorTable[A]

    attributes: protected
  26. def callbacks : Seq[LifecycleEvent]

  27. def clone () : AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef
  28. def columnNameFromPropertyName (propertyName: String) : String

  29. def columnTypeFor (fieldMetaData: FieldMetaData, owner: org.squeryl.Table[_]) : Option[String]

    Use this method to override the DatabaseAdapter's default column type for the given field (FieldMetaData), returning None means that no override will take place.

    Use this method to override the DatabaseAdapter's default column type for the given field (FieldMetaData), returning None means that no override will take place.

    There are two levels at which db column type can be overriden, in order of precedence :

    on(professors)(p => declare( s.yearlySalary is(dbType("real")) ))

    overrides (has precedence over) :

    MySchema extends Schema { ... override def columnTypeFor(fieldMetaData: FieldMetaData, owner: Table[_]) = if(fieldMetaData.wrappedFieldType.isInstanceOf[Int) Some("number") else None }

  30. def columns (fieldList: org.squeryl.dsl.ast.TypedExpressionNode[_]*) : ColGroupDeclaration

  31. def create : Unit

  32. def createColumnGroupConstraintsAndIndexes : Unit

  33. def dbType (declaration: String) : DBType

    attributes: protected
  34. def declare [B] (a: BaseColumnAttributeAssignment*) : BaseColumnAttributeAssignment*

    protected since table declarations must only be done inside a Schema

    protected since table declarations must only be done inside a Schema

    attributes: protected
  35. def defaultColumnAttributesForKeyedEntityId (typeOfIdField: Class[_]) : scala.collection.immutable.Set[_ >: org.squeryl.internals.PrimaryKey <: Product with org.squeryl.internals.AttributeValidOnNumericalColumn]

  36. def defaultLengthOfString : Int

    returns

    the default database storage (column) length for String columns for this Schema, Can be overridden by the Column Annotation ex.: Column(length=256) default is 128

  37. def defaultSizeOfBigDecimal : (Int, Int)

    returns

    a Tuple2 with (LengthOfDecimal, Scale) that will determine the storage length of the database type that map fields of type java.lang.BigDecimal Can be overridden by the Column Annotation, ex.: Column(length=22, scale=20) default is (20,16)

  38. def drop : Unit

    This will drop all tables and related sequences in the schema.

    This will drop all tables and related sequences in the schema... it's a dangerous operation, typically this is only useful for development database instances, the method is protected in order to make it a little less 'accessible'

  39. def eq (arg0: AnyRef) : Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  40. def equals (arg0: Any) : Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any
  41. def factoryFor [A] (table: Table[A]) : PosoFactoryPercursorTable[A]

    attributes: protected
  42. def finalize () : Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef
  43. def findTablesFor [A] (a: A) : Iterable[Table[A]]

  44. def getClass () : java.lang.Class[_]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  45. def hashCode () : Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  46. def indexed (indexName: String) : Indexed

    attributes: protected
  47. def indexed : Indexed

    attributes: protected
  48. def isInstanceOf [T0] : Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  49. def name : Option[String]

  50. def named (name: String) : Named

    attributes: protected
  51. def ne (arg0: AnyRef) : Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  52. def notify () : Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  53. def notifyAll () : Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  54. def on [A] (table: Table[A])(declarations: (A) ⇒ Seq[BaseColumnAttributeAssignment]) : Unit

    protected since table declarations must only be done inside a Schema

    protected since table declarations must only be done inside a Schema

    attributes: protected
  55. def onDelete : ReferentialEvent

    attributes: protected
  56. def onUpdate : ReferentialEvent

    attributes: protected
  57. def primaryKey : PrimaryKey

    attributes: protected
  58. def printDdl (statementHandler: (String) ⇒ Unit) : Unit

  59. def printDdl (pw: PrintWriter) : Unit

  60. def printDdl : Unit

    Prints the schema to standard output, it is simply : schema.

    Prints the schema to standard output, it is simply : schema.printDdl(println(_))

  61. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  62. def table [T] (name: String, prefix: String)(implicit manifestT: Manifest[T]) : Table[T]

    attributes: protected
  63. def table [T] (name: String)(implicit manifestT: Manifest[T]) : Table[T]

    attributes: protected
  64. def table [T] ()(implicit manifestT: Manifest[T]) : Table[T]

    attributes: protected
  65. def tableNameFromClass (c: Class[_]) : String

  66. def tableNameFromClassName (tableName: String) : String

  67. def tables : Seq[org.squeryl.Table[_]]

  68. implicit def thisSchema : Schema

    attributes: protected implicit
  69. def toString () : String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: AnyRef → Any
  70. def uninsertable : Uninsertable

    attributes: protected
  71. def unique : Unique

    attributes: protected
  72. def unupdatable : Unupdatable

    attributes: protected
  73. def view [T] (name: String)(implicit manifestT: Manifest[T]) : View[T]

    attributes: protected
  74. def view [T] ()(implicit manifestT: Manifest[T]) : View[T]

    attributes: protected
  75. def wait () : Unit

    attributes: final
    definition classes: AnyRef
  76. def wait (arg0: Long, arg1: Int) : Unit

    attributes: final
    definition classes: AnyRef
  77. def wait (arg0: Long) : Unit

    attributes: final
    definition classes: AnyRef

Inherited from AnyRef

Inherited from Any