TruxtonRelation - Revision history

Sam: /* Sample */

2024-01-27T19:14:04Z

Sample

Sam: /* Attributes and Methods */

2023-06-02T09:03:11Z

Attributes and Methods

Sam at 11:35, 1 October 2022

2022-10-01T11:35:21Z

Sam at 21:05, 16 September 2022

2022-09-16T21:05:54Z

Sam at 17:53, 30 July 2022

2022-07-30T17:53:04Z

Sam: /* Sample */

2021-02-09T14:55:24Z

Sample

Sam at 21:17, 30 November 2020

2020-11-30T21:17:04Z

Sam at 10:40, 29 May 2020

2020-05-29T10:40:24Z

Sam: /* relation */

2020-05-29T10:20:07Z

relation

Sam at 10:14, 29 May 2020

2020-05-29T10:14:30Z

@@ Line 137: / Line 137: @@
 if __name__ == "__main__":
-   main()
+   sys.exit(main())
 </source>

@@ Line 4: / Line 4: @@
 =Attributes and Methods=
-==<code>a: object</code>==
+==<code>a: str</code>==
 This is the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the object.
 This corresponds to the <code>[A_ID]</code> column of the <code><nowiki>[</nowiki>[[Relation Table|Relation]]<nowiki>]</nowiki></code> table.
@@ Line 15: / Line 15: @@
 It should contain a value in the <code>[ID]</code> column of the <code>[ObjectType]</code> table or you can use a [[Object Types | defined constant.]]
-==<code>b: object</code>==
+==<code>b: str</code>==
 This is the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the object.
 This corresponds to the <code>[B_ID]</code> column of the <code><nowiki>[</nowiki>[[Relation Table|Relation]]<nowiki>]</nowiki></code> table.
@@ Line 32: / Line 32: @@
 It is known as an [https://en.wikipedia.org/wiki/Vertex_(graph_theory) edge] in a graph.
-==<code>source: object</code>==
+==<code>source: str</code>==
 This is the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the object this relation came from.
 This corresponds to the <code>[SourceID]</code> column of the <code><nowiki>[</nowiki>[[Relation Table|Relation]]<nowiki>]</nowiki></code> table.

@@ Line 4: / Line 4: @@
 =Attributes and Methods=
-==<code>a: str</code>==
+==<code>a: object</code>==
 This is the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the object.
 This corresponds to the <code>[A_ID]</code> column of the <code><nowiki>[</nowiki>[[Relation Table|Relation]]<nowiki>]</nowiki></code> table.
@@ Line 15: / Line 15: @@
 It should contain a value in the <code>[ID]</code> column of the <code>[ObjectType]</code> table or you can use a [[Object Types | defined constant.]]
-==<code>b: str</code>==
+==<code>b: object</code>==
 This is the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the object.
 This corresponds to the <code>[B_ID]</code> column of the <code><nowiki>[</nowiki>[[Relation Table|Relation]]<nowiki>]</nowiki></code> table.
@@ Line 32: / Line 32: @@
 It is known as an [https://en.wikipedia.org/wiki/Vertex_(graph_theory) edge] in a graph.
-==<code>source: str</code>==
+==<code>source: object</code>==
 This is the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the object this relation came from.
 This corresponds to the <code>[SourceID]</code> column of the <code><nowiki>[</nowiki>[[Relation Table|Relation]]<nowiki>]</nowiki></code> table.

@@ Line 42: / Line 42: @@
 It should contain a value in the <code>[ID]</code> column of the <code>[ObjectType]</code> table or you can use a [[Object Types | defined constant.]]
-==<code>save() -> bool</code>==
+==<code>save() -> boolean</code>==
 This will commit the information to the <code><nowiki>[</nowiki>[[Relation Table|Relation]]<nowiki>]</nowiki></code> table.
 It will return [https://docs.python.org/3/library/constants.html#True True] if the record was saved to the database, [https://docs.python.org/3/library/constants.html#False False] if there was an error.
@@ Line 50: / Line 50: @@
 =Sample=
-<source lang="Python" highlight="63-69">
+<source lang="Python" highlight="64-70">
 import sys
 sys.path.append('C:/Program Files/Truxton/SDK')
@@ Line 71: / Line 71: @@
    event_type.name = name
    event_type.save()
 def add_file(parent_truxton_file, filename):
@@ Line 120: / Line 121: @@
    relation.relation = truxton.RELATION_LOGON_ACCOUNT
    relation.save()
 def main():
@@ Line 130: / Line 133: @@
    add_ec(root_file)
 if __name__ == "__main__":
    main()
 </source>

@@ Line 4: / Line 4: @@
 =Attributes and Methods=
-==<code>a</code>==
+==<code>a: str</code>==
 This is the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the object.
 This corresponds to the <code>[A_ID]</code> column of the <code><nowiki>[</nowiki>[[Relation Table|Relation]]<nowiki>]</nowiki></code> table.
@@ Line 10: / Line 10: @@
 This is also known as a [https://en.wikipedia.org/wiki/Vertex_(graph_theory) vertex] in a graph.
-==<code>atype</code>==
+==<code>atype: int</code>==
 The type of the thing that <code>a</code> represents.
 This corresponds to the <code>[A_ObjectTypeID]</code> column of the <code><nowiki>[</nowiki>[[Relation Table|Relation]]<nowiki>]</nowiki></code> table.
 It should contain a value in the <code>[ID]</code> column of the <code>[ObjectType]</code> table or you can use a [[Object Types | defined constant.]]
-==<code>b</code>==
+==<code>b: str</code>==
 This is the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the object.
 This corresponds to the <code>[B_ID]</code> column of the <code><nowiki>[</nowiki>[[Relation Table|Relation]]<nowiki>]</nowiki></code> table.
@@ Line 21: / Line 21: @@
 This is also known as a [https://en.wikipedia.org/wiki/Vertex_(graph_theory) vertex] in a graph.
-==<code>btype</code>==
+==<code>btype: int</code>==
 The type of the thing that <code>b</code> represents.
 This corresponds to the <code>[B_ObjectTypeID]</code> column of the <code><nowiki>[</nowiki>[[Relation Table|Relation]]<nowiki>]</nowiki></code> table.
 It should contain a value in the <code>[ID]</code> column of the <code>[ObjectType]</code> table or you can use a [[Object Types | defined constant.]]
-==<code>relation</code>==
+==<code>relation: int</code>==
 This provides the reason why <code>a</code> and <code>b</code> are related.
 This corresponds to the <code>[RelationTypeID]</code> column of the <code><nowiki>[</nowiki>[[Relation Table|Relation]]<nowiki>]</nowiki></code> table.
@@ Line 32: / Line 32: @@
 It is known as an [https://en.wikipedia.org/wiki/Vertex_(graph_theory) edge] in a graph.
-==<code>source</code>==
+==<code>source: str</code>==
 This is the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the object this relation came from.
 This corresponds to the <code>[SourceID]</code> column of the <code><nowiki>[</nowiki>[[Relation Table|Relation]]<nowiki>]</nowiki></code> table.
 This combined with <code>sourcetype</code> allows Truxton to retrieve the correct record from the database.
-==<code>sourcetype</code>==
+==<code>sourcetype: int</code>==
 The type of the thing that <code>source</code> represents.
 This corresponds to the <code>[SourceObjectTypeID]</code> column of the <code><nowiki>[</nowiki>[[Relation Table|Relation]]<nowiki>]</nowiki></code> table.
 It should contain a value in the <code>[ID]</code> column of the <code>[ObjectType]</code> table or you can use a [[Object Types | defined constant.]]
-==<code>save()</code>==
+==<code>save() -> bool</code>==
 This will commit the information to the <code><nowiki>[</nowiki>[[Relation Table|Relation]]<nowiki>]</nowiki></code> table.
 It will return [https://docs.python.org/3/library/constants.html#True True] if the record was saved to the database, [https://docs.python.org/3/library/constants.html#False False] if there was an error.

@@ Line 45: / Line 45: @@
 This will commit the information to the [[Relation Table | <code>Relation</code>]] table.
 It will return [https://docs.python.org/3/library/constants.html#True True] if the record was saved to the database, [https://docs.python.org/3/library/constants.html#False False] if there was an error.
 =Sample=
-<syntaxhighlight lang="Python" highlight="47-52">
+<syntaxhighlight lang="Python" highlight="61-67">
 import truxton
 import shutil
@@ Line 95: / Line 98: @@
    child_file = add_file(parent_file, "JW-v-DOJ-reply-02743.pdf")
-   artifact = child_file.newartifact()
+   a = child_file.newartifact()
-   artifact.type = truxton.ENTITY_TYPE_AUTHOR
+   a.type = truxton.ENTITY_TYPE_ACCOUNT
-   artifact.value = "Bob Smith"
+   a.value = "r0cker"
-   artifact.datatype = truxton.DATA_TYPE_ASCII
+  a.datatype = truxton.DATA_TYPE_ASCII
-   artifact.length = 9
+  a.length = 6
-   artifact.save()
+  a.save()
 def main():