From 1a96371f7772a8e0a996581caed0b1f31addc554 Mon Sep 17 00:00:00 2001 From: Pablo Duboue Date: Mon, 13 Dec 2021 20:48:46 -0800 Subject: [PATCH] Fixed wrong escaping in code examples This PR fixes the bug filled against the main project: https://github.com/squeryl/squeryl/issues/276 Fixing these examples can particularly help with this comment: "On a first look at some snippets one might incorrectly assume this library uses tons of unituitive custom symbolic operators.". Dropping pygments is related to: https://docs.github.com/github/working-with-github-pages/troubleshooting-jekyll-build-errors-for-github-pages-sites#fixing-highlighting-errors This is how the new pages render: https://drdub.github.io/squeryl.github.io/docs/0.9.5/introduction.html --- _config.yml | 2 +- docs/0.9.5/0.9.6.md | 99 +++---- docs/0.9.5/arbitrary-select-expressions.md | 32 +- docs/0.9.5/complete-example.md | 264 ++++++++--------- docs/0.9.5/composite-keys.md | 67 ++--- docs/0.9.5/contributing.md | 18 +- docs/0.9.5/custom-functions.md | 95 +++--- docs/0.9.5/dynamic-queries.md | 69 ++--- docs/0.9.5/faq-caching.md | 8 +- docs/0.9.5/faq-relations.md | 20 +- docs/0.9.5/faq-why-not-jpa.md | 81 +++-- docs/0.9.5/getting-started.md | 29 +- docs/0.9.5/group-and-aggregate.md | 39 +-- docs/0.9.5/introduction.md | 38 +-- docs/0.9.5/joins.md | 193 ++++++------ docs/0.9.5/limitations.md | 76 +++-- docs/0.9.5/miscellaneous.md | 28 +- docs/0.9.5/occ.md | 24 +- docs/0.9.5/pagination.md | 22 +- docs/0.9.5/performance-profiling.md | 36 +-- docs/0.9.5/relations.md | 329 +++++++++------------ docs/0.9.5/scalap.md | 12 +- docs/0.9.5/schema-definition.md | 251 +++++++--------- docs/0.9.5/selects.md | 211 +++++++------ docs/0.9.5/sessions-and-tx.md | 68 ++--- docs/0.9.5/stateful-relations.md | 81 ++--- docs/0.9.5/type-mapping.md | 24 +- 27 files changed, 979 insertions(+), 1237 deletions(-) diff --git a/_config.yml b/_config.yml index 9073719..25975a0 100644 --- a/_config.yml +++ b/_config.yml @@ -1,3 +1,3 @@ name: squeryl markdown: kramdown -pygments: true +highlighter: rouge diff --git a/docs/0.9.5/0.9.6.md b/docs/0.9.5/0.9.6.md index fb74d11..942c01f 100644 --- a/docs/0.9.5/0.9.6.md +++ b/docs/0.9.5/0.9.6.md @@ -19,90 +19,69 @@ only it’s companion object #### In the next example, we defined an object SquerylEntrypointForMyApp that will be imported in an application wherever the DSL is used. -**Warning**: Although deprecared, the org.squeryl.PrimitiveTypeMode -companion object can still be used for backward compatibility. -If it is used, it **cannot** be used in a same application with other -instance of the -org.squeryl.PrimitiveTypeMode trait. +**Warning**: Although deprecated, the org.squeryl.PrimitiveTypeMode companion object can still be used for backward compatibility. +If it is used, it **cannot** be used in a same application with other instance of the org.squeryl.PrimitiveTypeMode trait. diff --git a/docs/0.9.5/arbitrary-select-expressions.md b/docs/0.9.5/arbitrary-select-expressions.md index b7b347d..d962a39 100644 --- a/docs/0.9.5/arbitrary-select-expressions.md +++ b/docs/0.9.5/arbitrary-select-expressions.md @@ -12,22 +12,13 @@ Sometimes the expressions needs to be evaluated on the database side, this is what the **&** function does : - Note that the return type are equivalent in both cases, i.e. both @@ -36,13 +27,10 @@ select(&(a.id \* 1000)) A select can have more than one invocation of & : diff --git a/docs/0.9.5/complete-example.md b/docs/0.9.5/complete-example.md index 984a7f1..7f96e34 100644 --- a/docs/0.9.5/complete-example.md +++ b/docs/0.9.5/complete-example.md @@ -5,174 +5,144 @@ headtitle: Examples - --- diff --git a/docs/0.9.5/composite-keys.md b/docs/0.9.5/composite-keys.md index 8607e84..93d8f0b 100644 --- a/docs/0.9.5/composite-keys.md +++ b/docs/0.9.5/composite-keys.md @@ -15,16 +15,11 @@ Consider the following example where CourseAssignment is a KeyedEntity\[CompositeKey2\[Long,Long\]\] CourseAssignment.id is a unique identifier for a CourseAssignment. In @@ -58,50 +53,36 @@ relations (see : [issue 25](http://www.assembla.com/spaces/squeryl/tickets/25)) - diff --git a/docs/0.9.5/contributing.md b/docs/0.9.5/contributing.md index de79f99..c0953ae 100644 --- a/docs/0.9.5/contributing.md +++ b/docs/0.9.5/contributing.md @@ -25,19 +25,15 @@ When that is not possible, sending the AST of the query (with Query\[T\].dumpAst) is also helpful : Submitting Ideas and Issues diff --git a/docs/0.9.5/custom-functions.md b/docs/0.9.5/custom-functions.md index 39dc9ef..9f44e7f 100644 --- a/docs/0.9.5/custom-functions.md +++ b/docs/0.9.5/custom-functions.md @@ -10,54 +10,42 @@ returns a String You can define : Then you can use the sha1 function in expressions : The arguments and return type of your custom function need be one of the following Squeryl types (defined in org.squeryl.dsl) : -Where : +Where: - A is Int, Long, Float, Double, BigDecimal or Option\[Int\], Option\[Long\], etc… @@ -71,35 +59,32 @@ PrimitiveTypeMode, CustomTypeMode and RecordTypeMode (org.squeryl.dsl.TypeArithmetic)) diff --git a/docs/0.9.5/dynamic-queries.md b/docs/0.9.5/dynamic-queries.md index acb35d1..0915ffd 100644 --- a/docs/0.9.5/dynamic-queries.md +++ b/docs/0.9.5/dynamic-queries.md @@ -25,56 +25,51 @@ query Example : -Notice the Option\[\] in the result type of the query, and how the -Author -table disappears from the generated SQL base on the input of -**inhibitWhen** : - - - + {% include 0.9.5/feature-dyn-where-clause.html%} diff --git a/docs/0.9.5/faq-caching.md b/docs/0.9.5/faq-caching.md index b290db6..7a247f0 100644 --- a/docs/0.9.5/faq-caching.md +++ b/docs/0.9.5/faq-caching.md @@ -13,11 +13,13 @@ caching with lazy loading is possible : diff --git a/docs/0.9.5/faq-relations.md b/docs/0.9.5/faq-relations.md index fc1206f..95a150b 100644 --- a/docs/0.9.5/faq-relations.md +++ b/docs/0.9.5/faq-relations.md @@ -15,18 +15,15 @@ with more reuse. Consider for example a “one to many” relation : @@ -52,10 +49,11 @@ Here’s how it happens, suppose you execute the following : diff --git a/docs/0.9.5/faq-why-not-jpa.md b/docs/0.9.5/faq-why-not-jpa.md index 7eb7df9..4ccafa5 100644 --- a/docs/0.9.5/faq-why-not-jpa.md +++ b/docs/0.9.5/faq-why-not-jpa.md @@ -12,73 +12,68 @@ Can you spot the typo in this JPA query ? **Let’s hope that you can, because the compiler won’t tell you !** -If you happen to rename a column, change it’s type, remove it, etc. +If you happen to rename a column, change it’s type, remove it, etc. the compiler will be of no help. -If you use JPAs relation mechanism to *navigate* through the object -graph, -like the following example illustrates, you will regain type safety, -but at the cost of horrible performance, -Can you count the number of database calls resulting from this JPA query -? +If you use JPAs relation mechanism to *navigate* through the object graph, +like the following example illustrates, you will regain type safety, +but at the cost of horrible performance, +Can you count the number of database calls resulting from this JPA query? -The answer is : two database round trips for every row returned by the -findBySubjectId query, -an N-ary relation typically causes O (N-1) calls to the database, which -can have disastrous +The answer is : two database round trips for every row returned by the findBySubjectId query, +an N-ary relation typically causes O (N-1) calls to the database, which can have disastrous performance consequences. -Squeryl allows you to combine the efficiency of the first approach +Squeryl allows you to combine the efficiency of the first approach (the query is done in a single database call), and the type safety of -the second : +the second: diff --git a/docs/0.9.5/getting-started.md b/docs/0.9.5/getting-started.md index de83bf7..5a50f7f 100644 --- a/docs/0.9.5/getting-started.md +++ b/docs/0.9.5/getting-started.md @@ -17,25 +17,27 @@ Declare the Squeryl dependency in the SBT project definiition -***Note*** : *The Oracle driver is not available via SBT/Maven, you will -have to downloaded manually.* +***Note*** : *The Oracle driver is not available via SBT/Maven, you will have to downloaded manually.* -The remaining steps are : +The remaining steps are: 1. [Bootstrap the session factory](http://squeryl.org/sessions-and-tx.html) @@ -48,10 +50,9 @@ run queries. ### Manual dependency management If you want to manage your dependencies without SBT or Maven, you will -need the following jars : +need the following jars: -- The Scala runtime jar, version 2.11.x, 2.10.x, 2.9.3, 2.9.2, 2.9.1, - 2.9.0 +- The Scala runtime jar, version 2.11.x, 2.10.x, 2.9.3, 2.9.2, 2.9.1, 2.9.0 - The Squeryl jar found [here](http://github.com/max-l/Squeryl/downloads) - The CGLIB cglib-nodep-2.2.jar, found diff --git a/docs/0.9.5/group-and-aggregate.md b/docs/0.9.5/group-and-aggregate.md index 22aad05..6aa8b6b 100644 --- a/docs/0.9.5/group-and-aggregate.md +++ b/docs/0.9.5/group-and-aggregate.md @@ -49,14 +49,14 @@ Here is an example, the following Squeryl statement : @@ -67,18 +67,19 @@ Translates into this SQL statement : diff --git a/docs/0.9.5/introduction.md b/docs/0.9.5/introduction.md index c3d630d..4472e43 100644 --- a/docs/0.9.5/introduction.md +++ b/docs/0.9.5/introduction.md @@ -32,15 +32,15 @@ Here is a comparison of a Squeryl and a JPA version of the same query :